Add docs for Dev Containers #407
Conversation
|
@SteveMacenski , here is some documentation on my devcontainer work that we discussed over the previous Nav2 meeting. |
|
We can save the restructuredtext for last, and I'll refactor docker build instructions based on feedback of what is written thus far. |
There was a problem hiding this comment.
So this isn't strictly for codespaces? I read through most of it and seems good to me!
The only thing I'd ask is that if you haven't yet, to start with a blank slate and follow only the letter of your instructions in this page to see if you can get a successful result at the end. If not, add the details that might be missing for a novice user. We don't want this page to become a hot spot of tickets asking for support because something was unclear or they got stuck on something obvious to you as an existing user of the capability. I do this for every tutorial I write just to make sure I didn't miss anything important
to shorten the introduction
to prevent warning as described here: https://myst-parser.readthedocs.io/en/latest/syntax/organising_content.html#document-structure
as an alternative to codespaces
By adding "colon_fence" to myst_enable_extensions https://myst-parser.readthedocs.io/en/latest/syntax/optional.html#syntax-colon-fence
to omit remarks about EOL distros
also helps keep the commands shell agnostic e.g. using another shell such as fish
to fix warnings - sphinx-doc/sphinx#10474
from markdown pattern to fix warnings
to ensure build_instructions is included in the sidebar
otherwise the sidebar navigation open duplicate dropdowns
and make it default
for better debugging
|
Current layout:
|
|
It looks like your changes broke the mechanism where artifacts are generated so I can see the output and website files in circleci https://app.circleci.com/pipelines/github/ros-planning/navigation.ros.org/1676/workflows/5e58a602-fac9-421b-993b-abd9d0e0dfaa/jobs/1985/artifacts. The job has no recorded artifacts. |
with respect to working_directory in docs_exec
Related:
TODO: