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

Slightly improve documentation #143

Merged
merged 12 commits into from Sep 2, 2019

Conversation

@Fonata
Copy link
Contributor

commented Aug 16, 2019

Feedback is very welcome.

Fonata added 4 commits Aug 16, 2019
Documentation of config options: Improve db
Signed-off-by: Christian Bläul <christian@blaeul.de>
Documentation of config options: Improve loglevel
Signed-off-by: Christian Bläul <christian@blaeul.de>
Config documentation: Improved spelling and capitalization of services
Signed-off-by: Christian Bläul <christian@blaeul.de>
Improved docs for YAML metadata
Signed-off-by: Christian Bläul <christian@blaeul.de>
@ccoenen

This comment has been minimized.

Copy link
Member

commented Aug 16, 2019

Very welcome changes. Very good indeed. There's one other file that might need a little love, too: the configuration via environment variables:

https://github.com/codimd/server/blob/9c1665ae5bf3cf38210ffd862d10de9b13bfacdd/docs/configuration-env-vars.md

would you like to take a look at that, too? (it's totally fine if you do not have time for that, I just thought I'd ask)

Fonata added 2 commits Aug 17, 2019
Documentation: converted descriptions to sentences to allow more details
No content was added; this is just a formatting commit.

Signed-off-by: Christian Bläul <christian@blaeul.de>
Documentation: Improved descriptions of 'Users and Privileges' section
Signed-off-by: Christian Bläul <christian@blaeul.de>
@Fonata

This comment has been minimized.

Copy link
Contributor Author

commented Aug 17, 2019

@ccoenen Thanks for your feedback. Yes, I'll check env documentation, too.

I'll add a message once I think I'm done.

Fonata added 6 commits Aug 17, 2019
Documentation: improved dbURL description
Signed-off-by: Christian Bläul <christian@blaeul.de>
Documentation: improved 'Email (local account)' sections
Signed-off-by: Christian Bläul <christian@blaeul.de>
Documentation: improved sessionLife description
Signed-off-by: Christian Bläul <christian@blaeul.de>
Not serverurl, but serverURL is used as a default for issuer
Signed-off-by: Christian Bläul <christian@blaeul.de>
Documentation: improved English
Signed-off-by: Christian Bläul <christian@blaeul.de>
Documentation: improved 'Users and Privileges' section
Signed-off-by: Christian Bläul <christian@blaeul.de>
@Fonata

This comment has been minimized.

Copy link
Contributor Author

commented Aug 17, 2019

I've finished my work on configuration-env-vars.md.

This PR is now ready for review. I don't plan to add more commits unless requested by the reviewer(s).

@SISheogorath
Copy link
Member

left a comment

LGTM as we are already on it we might want to change the gravatar section, to make clear that we use libravatar instead of the usual gravatar now, due to better privacy.

@Fonata

This comment has been minimized.

Copy link
Contributor Author

commented Aug 23, 2019

Thanks for the feedback ☺️

I don't plan to update the Gravatar section soon, so I created a separate issue #153 to unblock this PR from getting merged.

@SISheogorath SISheogorath merged commit c765f34 into codimd:master Sep 2, 2019

4 checks passed

DCO DCO
Details
WIP Ready for review
Details
continuous-integration/travis-ci/pr The Travis CI build passed
Details
security/snyk - package.json (codimd) No manifest changes detected

@Fonata Fonata deleted the Fonata:improve-docs branch Sep 14, 2019

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
3 participants
You can’t perform that action at this time.