-
Notifications
You must be signed in to change notification settings - Fork 9
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.
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
Compute RP feedback - improve ReadTheDocs web navigation of docs #68
base: main
Are you sure you want to change the base?
Conversation
This build appears to fail because I've already verified my changes in my test environment where warnings don't cause build failures. I had intentionally excluded If anyone has a clue how to circumvent this issue without setting One option could potentially be to remove the |
@c-mart an additional pair of eyes would be great! Note: this issue may be resolved with the recent discussion to switch from sphinx to mkdocs. |
Tried this out locally to understand (I'm new to reST toctree). Comparison screenshots have The navigation pane now goes deeper, showing each task on the left-hand side. What happens after I click on a task? On To fix the build warning, I tried adding Things that me unsure how to proceed:
How about this plan?
|
@c-mart, thank you for the detailed response! Your plan looks great, and I'll begin the process of breaking components into separate PR(s). #67 is the RP feedback that was provided. I've interpreted it to be similar to a Jira User Story and this subsequent PR (#68) being similar to the technical efforts to try to meet the expectations of the feedback. I understand that the badging initiative will eventually deprecate a decent bit of this documentation organizing effort, but I believe we should still make strides to improving the current roadmap method to support current RPs that are actively integrating into ACCESS. |
This PR is meant to satisfy #67 for improving navigation of roadmaps and their grouped tasks by utilizing
toctree
.Additionally, some auxiliary improvements have been included in this PR:
I had wanted to use the
toctree
:numbered:
feature rather than hard-coding the numbers for Roadmap tasks, but I wasn't able to figure out how to get the automatic numbering to be accurate/consistent. This might be due to the fact that multiple Roadmap Tracks reference to the same task file. I've decided that it can be out of the scope of this PR, but I'm happy to incorporate a solution if anyone knows what's needed!NOTE: This PR is scoped for all current Roadmap Tracks (Cloud, Compute, Storage, Science Gateways, and Online Services).