Skip to content
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

Merged
merged 6 commits into from
Apr 11, 2020
Merged

Conversation

koenmtb1
Copy link
Contributor

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

  • I have read the contributing guidelines.
  • I have read the security policy.
  • I confirm that this pull request does not address a security vulnerability. If this pull request addresses a security.
    vulnerability, I confirm that I got green light (please contact security@ory.sh) from the maintainers to push the changes.
  • I have added tests that prove my fix is effective or that my feature works.
  • I have added or changed the documentation.

@koenmtb1 koenmtb1 changed the title Added database connection documentation docs: Added database connection documentation Apr 10, 2020
"type": "string"
"type": "string",
"title": "Data Source Name",
"description": "DSN is used to specify the database credentials as a connection URI."
Copy link
Member

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.

Suggested change
"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.

Copy link
Contributor Author

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?

.schema/config.schema.json Outdated Show resolved Hide resolved
@aeneasr aeneasr merged commit 4f9e8b0 into ory:master Apr 11, 2020
@aeneasr
Copy link
Member

aeneasr commented Apr 11, 2020

Awesome, thank you for your contribution!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants