docs: add anchor tags for command-line flags#3509
Conversation
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
With this, the sections are linked from the "options" table when producing the documentation on docs.docker.com Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
This will generate "details_url" for options, so that the options table on the pages at docs.docker.com link to the section describing the option. Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
Codecov Report
@@ Coverage Diff @@
## master #3509 +/- ##
=======================================
Coverage 59.00% 59.00%
=======================================
Files 284 284
Lines 23839 23839
=======================================
Hits 14066 14066
Misses 8914 8914
Partials 859 859 |
This updates the yamldocs for the engine cli reference with updated sources that include anchor tags for flags; this should make the flags in the "options" table clickable and scroll to the relevant section on the page (where present). This was built from docker/cli#3509, which is not yet merged (and has changes for the upcoming engine release, so cannot yet be published here). Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
|
opened docker/docs#14478 to test it in the docs repository |
|
Alright; this works; it's not perfect yet, as there's many flags that don't have a dedicated section (yet), and there's some flags that are described in combination with other flags (e.g. grouping This page, for example, now has anchors for various flags; https://deploy-preview-14478--docsdocker.netlify.app/engine/reference/commandline/build/#options We should also have a look at making the links more visible in the Options table, as currently it's not clear which ones are clickable, and which ones are not. |
|
@silvin-lubecki @crazy-max PTAL (you may want to review per-commit; first couple of commits were some formatting fixes) |
|
alright; let's get this one in (I think there's a couple of headers I missed, but it's a start) |
3 participants
This will generate "details_url" for options, so that the options
table on the pages at docs.docker.com link to the section describing
the option.
- How to verify it
- Description for the changelog
- A picture of a cute animal (not mandatory but encouraged)