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

Update configuration docs #521

Closed
wants to merge 3 commits into from
Closed

Update configuration docs #521

wants to merge 3 commits into from

Conversation

jchristgit
Copy link
Member

When I started the Django app in January 2019, I documented a setup guide and environment variables for local configuration of the app here. These were lacking the new $METRICITY_DB_URL environment variable. The setup.md file was also changed to simply be a symlink to the current contributing guide for the site.

@coveralls
Copy link

Coverage Status

Coverage remained the same at 100.0% when pulling 2b7d1c3 on update-config-docs into 7d81829 on main.

Copy link
Member

@kosayoda kosayoda left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Do we even need a docs/ directory at this point, since all of the configuration here is essentially duplicated in the contributing guide?

@jchristgit
Copy link
Member Author

Yes, but also no. The setup.md now links to the contributing guide. However, the configuration information is not part of the contributing guide. That said, I'm not sure how important the configuration information is for someone starting to contribute, as the setup guide documents how to run the app locally & configuration.md mostly documents additional options.

@kosayoda
Copy link
Member

kosayoda commented Jun 5, 2021

Is configuration.md not essentially this section right here?

The only variables I see that are missing in the contributing guide are LOG_LEVEL and ALLOWED_HOSTS, both of which I doubt is much used for testing (although I have 0 qualms with adding them to the site guide).

@jchristgit
Copy link
Member Author

Is configuration.md not essentially this section right here?

Partially, yes. config.md was made to explain what the environment variables actually do, whilst the setup guide mostly recommends what to set it to. I'd be open to moving the explanations of config.md to the contributing guide.

@kosayoda
Copy link
Member

kosayoda commented Jun 5, 2021

I'll discuss this with the core devs then get back to you, thanks for the other minor enhancements by the way!

@kosayoda
Copy link
Member

kosayoda commented Jun 5, 2021

@jchristgit The consensus is in favour of removing the docs/ directory and moving the knowledge to the site contributing guide. Would you be willing to create a PR for that?

@jchristgit
Copy link
Member Author

@jchristgit The consensus is in favour of removing the docs/ directory and moving the knowledge to the site contributing guide. Would you be willing to create a PR for that?

Yes, I'd be happy to do so. I'll try to do that today, if that doesn't work, it'll chime in here next week

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.

None yet

3 participants