Uh oh!
There was an error while loading. Please reload this page.
engine: update reference docs to use new anchor tags - #16460
Conversation
✅ Deploy Preview for docsdocker ready!
To edit notification comments on pull requests, go to your Netlify site settings. |
thaJeztah
left a comment
There was a problem hiding this comment.
the "fix anchor links" commit still needs to be squashed before merging as well
Uh oh!
There was an error while loading. Please reload this page.
Uh oh!
There was an error while loading. Please reload this page.
| - repo: "https://github.com/docker/cli" | ||
| # FIXME(thaJeztah): temporarily using branch from https://github.com/docker/cli/pull/3525 to fix htmlproofer validation | ||
| - repo: "https://github.com/thaJeztah/cli" | ||
| default_branch: "master" | ||
| ref: "20.10" | ||
| ref: "20.10_backport_anchor_tags" |
There was a problem hiding this comment.
- This is temporary for this PR, and will be removed before merging (after [20.10 backport] docs: add anchor tags for command-line flags cli#3525 is merged)
a95edf9 to
4ead9b9Compareb2f2e86 to
563ac7dComparethaJeztah
commented
Jan 9, 2023
I did a quick test with only the second commit of this PR to check if htmlproofer would fail, but looks good, so docker/cli#3525 is probably good to go |
563ac7d to
87395d7CompareThe updated version uses new anchors for flags, so updates are needed elsewhere to update those anchors. Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
87395d7 to
a7b9985ComparethaJeztah
commented
Jan 9, 2023
This one should be ready for review now |
Just an observation: I was looking at the Options table in https://deploy-preview-16460--docsdocker.netlify.app/engine/reference/commandline/build/ and I don't see any generated link on the name like |
thaJeztah
commented
Jan 9, 2023
@crazy-max you mean the TOC (right-hand side)? I guess this is because Jekyll doesn't understand the |
thaJeztah
commented
Jan 9, 2023
@crazy-max It's probably this one that needs updating; docs/_includes/toc_pure_liquid.html Lines 1 to 17 in 1f4f22c |
crazy-max
commented
Jan 9, 2023
Not the TOC, the Options table where |
thaJeztah
commented
Jan 9, 2023
Let me bring this one in 👍 |
This updates the engine reference documentation with the changes from docker/cli#3525. We're using the new anchor tags for the upcoming 23.0 release, and this PR prepares changes related to that, so that updating the docs for v23.0.0 will be easier (all things already updated)..
Once these changes are in, we can also fix the buildx docs to point to the new anchor tags, and remove the htmlproofer exclusion.