Start consolidation of documentation #391
Merged
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Change
Expand on the documentation, and start consolidating it into one place.
The current state is not yet ready for public consumption, but I think the idea is clear and ready for feedback.
While I would not require it to be perfect, I do think we need a little extra effort to modify existing documentation to better make use of the new structure. The follow up would be to do improve that integration and set up an automatic build and deploy workflow.
How to Test
Locally:
Visit http://localhost:8000/docs (assuming you do not have the metadata catalogue service running locally).
You can browse the documentation.
Since these are documentation changes, they do not warrant additional tests.
In fact, I disabled unit tests from the pre-commit hook if only markdown files are changed in a commit.
Checklist
Related Issues
N/A