Re-organize docs navigation and add releasing guide#428
Re-organize docs navigation and add releasing guide#428martinRenou merged 8 commits intogeojupyter:mainfrom
Conversation
This text becomes the hyperlink text in Sphinx, and it takes up too much room!
|
|
|
Integration tests report: appsharing.space |
This is kinda uncool, but at the moment our linter does not allow absolute links. It makes it much harder to reorganize documentation files.
|
I wanted to use absolute paths for the image links to make it easier to rearrange documentation in the future. The check-links underlying library https://github.com/jupyterlab/pytest-check-links doesn't support it yet. |
mfisher87
changed the title
There was a problem hiding this comment.
Thanks @mfisher87, this looks great 👍
I just have a minor comment, no a blocker.
|
|
||
| install | ||
| tutorials/index | ||
| features/index |
There was a problem hiding this comment.
I'm not convinced by that features part.
I wonder if we could not have extension and collaboration at top level.
There was a problem hiding this comment.
My thought process for this change was that this content (extension and collaboration) fall under the category of "explanation", and the audience is end-users. For that reason I thought (1) these things belong in the user guide; (2) it made sense to group these two things together in a directory where we can continue adding more explanatory content in the future.
What do you think about my reasoning?
Alternatively, what about grouping these documents under a "tour" or "About > Why JGIS?" structure? Some of the wordy content on the document index may also feel at home in a "About" section.
|
Much cleaner indeed! That's great! (When we have many more releases, listing all the versions might clutter the main page. But for now, it's definitely not an issue.). |
|
Thanks! |
* Move contributing docs into a directory * Remove project name from changelog doc title This text becomes the hyperlink text in Sphinx, and it takes up too much room! * Rearrange docs into "Contributing guide" and "User guide" * Add releasing doc * [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci * Fixup asset links in tutorial * Tabs to spaces 🔔 * Replace absolute links with relative links This is kinda uncool, but at the moment our linter does not allow absolute links. It makes it much harder to reorganize documentation files. --------- Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
4 participants
Description
Resolves #265
Resolves #411
The navigation now has 3 elements: User guide, Contributor guide, and Changelog. Everything is grouped under these categories.
Added a releasing guide based on JupyterLite's.
Checklist
Resolves #XXX.Failing lint checks can be resolved with:
pre-commit run --all-filesjlpm run lint📚 Documentation preview: https://jupytergis--428.org.readthedocs.build/en/428/
💡 JupyterLite preview: https://jupytergis--428.org.readthedocs.build/en/428/lite