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

Reorganize docs and configs into a docs folder #661

Closed
jonespm opened this issue Aug 14, 2019 · 3 comments · Fixed by #1398
Closed

Reorganize docs and configs into a docs folder #661

jonespm opened this issue Aug 14, 2019 · 3 comments · Fixed by #1398
Assignees
@ssciolla
Labels
📖 documentation Involves updates to the README, CONTRIBUTING, or other supporting text files good first issue Good for newcomers low priority
Projects
MyLA-2022.02.01

Comments

@jonespm
Copy link
Member

jonespm commented Aug 14, 2019

Most large python projects seem to organize their documentation into a docs folder. This would probably make sense to do.

Like: https://github.com/django/django

We could move the config/env_sample.json, our existing docs and create something nice like
https://docs.readthedocs.io/en/stable/intro/getting-started-with-sphinx.html

Then as we documented the code better it would also generate better documentation. #

Originally posted by @jonespm in #657 (comment)
@project-bot project-bot bot added this to To do in MyLA-Default-Project Aug 14, 2019
@ssciolla ssciolla added the good first issue Good for newcomers label Nov 18, 2019
@huynhdom
Copy link

Hi. I'm a student currently taking 481 and I would like to take on this issue. Just wanted to inform you and I hope I can figure this out.

@justin0022
Copy link
Collaborator

Great @huynhdom let us know if you need a hand

@huynhdom huynhdom mentioned this issue Dec 10, 2019
Closed
@jennlove-um jennlove-um added the 📖 documentation Involves updates to the README, CONTRIBUTING, or other supporting text files label Sep 24, 2020
@jonespm jonespm linked a pull request Apr 5, 2021 that will close this issue
Add support for sphinx documentation #825
Closed
@jennlove-um jennlove-um removed this from To do in MyLA-Default-Project Jun 8, 2022
@jennlove-um jennlove-um added this to To do in MyLA-2022.02.01 via automation Jun 8, 2022
@jennlove-um jennlove-um moved this from To do to In progress in MyLA-2022.02.01 Jul 6, 2022
@ssciolla ssciolla mentioned this issue Aug 24, 2022
Merged
MyLA-2022.02.01 automation moved this from In progress to Review/QA Sep 7, 2022
ssciolla added a commit that referenced this issue Sep 7, 2022
@ssciolla
Split README.md into separate chunks in /docs, review content (#661…
04dbcab 
…) (#1398)

* Add first draft of docs reorganization for testing

* Unindent subpage list

* Fix accessibility link

* Add changes from first pass of getting_started.md

* Change default CSRF_COOKIE_SECURE value(?)

* Add first pass at revising configuration.md; update demo_init.sh.sample

* Add revisions/edits for CONTRIBUTING.md

* Break up a couple more lines

* Add newline at EOF in license_info.md

* Update spacing, link in accessibility.md

* Add first draft of testing.md revision

* Pin cypress version; add note about it not being maintained

* Fix heading levels in CONTRIBUTING

* Revise loading_data.md

* Add navigation links

* Modify README.md

* Add changes from second pass through getting_started.md

* Change styling of Note:

* Change one more Note:

* Add changes from second pass at configuration.md

* Add changes from second pass of CONTRIBUTING

* Add changes from second pass of loading_data.md

* Add changes from second pass of testing.md

* Add note about test plan; fix standard command

* Add quoting to make notes stand out

* Fix subpage numbering

* Remove sh in a couple places; add sql in one place

* Switch back CSRF_COOKIE_SECURE default; add explanatory comment

* Add back language identifiers

* Make a couple minor corrections
This was referenced Oct 11, 2022
Closed
Closed
@jennlove-um
Copy link
Contributor

The separate pages of the README.md look good. I verified and updated a couple of links and added navigation links at the bottom of pages to let users move from one section to the next without going back to the README page if they want.

@jennlove-um jennlove-um moved this from Review/QA to Done in MyLA-2022.02.01 Dec 14, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@ssciolla ssciolla

Labels
📖 documentation Involves updates to the README, CONTRIBUTING, or other supporting text files good first issue Good for newcomers low priority
Projects
No open projects
MyLA-2022.02.01
  
Done
Milestone
No milestone
5 participants
@jonespm @justin0022 @ssciolla @jennlove-um @huynhdom