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

document the documentation management process #8

Open

3 tasks

turbomam opened this issue May 4, 2022 · 0 comments

Assignees

Member

turbomam commented May 4, 2022

I would like to learn how to contribute to NMDC docuemtnation, and also to help others discuss this process with better shared understanding.

what does this repo do?
how is it triggered or executed?
- manually visiting the ReadTheDocs website and clicking a build button?
- could that be automated?
- are GitHub actions being used at all?
- is anything being deployed to GitHub pages?
- in what ways is this integrated with the NMDC Data Portal?
where should new input go?
- one of the Diataxis-themed folders in doc/, like
  - explanation
  - howto_guides
  - overview
  - reference

Do we have official titles for the various places where aggregated documentation may appear?

Various buzzwords I have heard in connection with this effort:

ReadTheDocs, RTD
reStructuredText, RST
- Which is preferred, MarkDown or RST? I mostly see MD in this repo.
Sphinx
- Are we really generating any documentation pages from comments in Python scripts? how does that get integrated into this repo?

The text was updated successfully, but these errors were encountered:

turbomam self-assigned this

eecavanna mentioned this issue

Document process of deploying documentation updates #58

Open

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment