-
Notifications
You must be signed in to change notification settings - Fork 968
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
docs: Added database connection documentation #332
Conversation
.schema/config.schema.json
Outdated
"type": "string" | ||
"type": "string", | ||
"title": "Data Source Name", | ||
"description": "DSN is used to specify the database credentials as a connection URI." |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Can you add your example here? It should then be rendered into the markdown file.
"description": "DSN is used to specify the database credentials as a connection URI." | |
"description": "DSN is used to specify the database credentials as a connection URI.", | |
"examples": ["postgres://user:password@localhost:5432/database"] |
To regenerate the configuration page run (in the project's root directory)
$ node docs/scripts/config.js docs/config.js
and then commit the markdown aswell.
We should really document how to do that.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Okay, did that. I also added a quick instruction for how to do it in the CONTRIBUTING.md. Maybe add it to the PR checks?
Awesome, thank you for your contribution! |
Related issue
Issue discussed in Slack with @zepatrik. No documentation for how to connect to a database was available.
Proposed changes
Adding documentation for how to connect to a database.
Checklist
vulnerability, I confirm that I got green light (please contact security@ory.sh) from the maintainers to push the changes.