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.

Sign up for GitHub

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

Jump to bottom

Add instructions for building docs to contributing guide #425

Closed
shaunagm opened this issue Oct 1, 2020 · 1 comment
Closed

Add instructions for building docs to contributing guide #425

shaunagm opened this issue Oct 1, 2020 · 1 comment
Assignees
@shepardjma
Labels
documentation Work type - improvements or additions to documentation good first issue These issues are great ones to start working on for Parsons newcomers! medium priority Priority - this doesn't need to be addressed immediately, but will broadly impact Parsons users

Comments

@shaunagm
Copy link
Collaborator

shaunagm commented Oct 1, 2020 •
edited
Loading

Currently, the contributing guide just says, about building docs:

Make your changes and re-build the docs (for now, please follow this guide and/or ask for help in Slack)

The docs should instead include the instructions for how to actually build the docs. Whoever solves this issue should prove that it works (at least on their machine) by building the docs from scratch.

Instructions are here but instead of listing out the packages to install we should just tell people to install whatever's in /docs/requirements.txt.
@shaunagm shaunagm added documentation Work type - improvements or additions to documentation good first issue These issues are great ones to start working on for Parsons newcomers! ragtag medium priority Priority - this doesn't need to be addressed immediately, but will broadly impact Parsons users labels Oct 1, 2020
@shaunagm shaunagm self-assigned this Oct 1, 2020
@shaunagm shaunagm mentioned this issue Oct 1, 2020
Closed
@shaunagm shaunagm removed their assignment Oct 2, 2020
@shepardjma
Copy link
Contributor

I am working on this.

@shaunagm shaunagm mentioned this issue Oct 8, 2020
Merged
@shaunagm shaunagm closed this as completed Oct 8, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@shepardjma shepardjma

Labels
documentation Work type - improvements or additions to documentation good first issue These issues are great ones to start working on for Parsons newcomers! medium priority Priority - this doesn't need to be addressed immediately, but will broadly impact Parsons users
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@shaunagm @shepardjma