-
Notifications
You must be signed in to change notification settings - Fork 2.5k
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
[CI:DOCS] Add anchors for flag names on docs.podman.io #8292
Conversation
Change the docs markdown so that flag names will be h4 headers. Sphinx will automatically add anchors to headers. Add css to make sure the flag names are not to big compared to the text. The man pages also still renders fine but it looks a bit different. Signed-off-by: Paul Holzinger <[email protected]>
lgtm |
/approve |
[APPROVALNOTIFIER] This PR is APPROVED This pull-request has been approved by: baude, Luap99 The full list of commands accepted by this bot can be found here. The pull request process is described here
Needs approval from an approver in each of these files:
Approvers can indicate their approval by writing |
I like it! LGTM |
/lgtm |
I'm not seeing the change on the attach page. Lookin at the source, I'm still seeing
Is it just taking a long time to push out there, or is there some under the covers resolution error? @baude? |
@TomSweeneyRedHat This is correct. I cannot change this. That's why I changed the css to match h4. |
@Luap99 so I'm confused. You are saying that the css needs to be adjusted before the anchors will show on the docs.podman.io pages? I like the change that you did here, but I'm not sure that it closed #7300. The point of that issue is they wanted a clickable icon to show up in the page so they could create a link directly to a particular option in the man page. |
@TomSweeneyRedHat If you hover the flag name you can click on the pilcrow on the right side of the flag name to generate the link. |
Nice work @Luap99 |
@Luap99 thanks! I was hovering on the left side of each and not seeing the link prior. Is there any way to flip the link to the other side of the line? I think that's where most folks would look for it and that's where it is in podman.io and buildah.io. |
Somewhere in the CIv2 migration we lost the man page vs --help cross-checker. Add it back, by adding it into the man-page-check Makefile target; this is part of 'make validate', which is run in CI even on CI:DOCS PRs. As happens when CI doesn't run, things broke. Man pages got out of sync with --help. This PR: 1) Fixes hack/xref-helpmsgs-manpages to deal with the new "Options" (instead of "Flags") form of podman help. containers#8034 did part of that, but one of my review comments was accidentally left out. 2) Fixes hack/xref-helpmsgs-manpages to deal with the new option syntax in man pages, post- containers#8292, in which each option is preceded by four hashes so as to make them HTML <h4> elements with named anchors. 3) Fixes man pages that containers#8292 accidentally missed. 4) Adds man page entries for two flags that got added to podman but not documented (pod create --network-alias, play kube --log-driver) Fixes: containers#8296 Signed-off-by: Ed Santiago <[email protected]>
Change the docs markdown so that flag names will be h4 headers.
Sphinx will automatically add anchors to headers. Add css to
make sure the flag names are not to big compared to the text.
The man pages also still renders fine but it looks a bit different.
Fixes #7300
old man page:
new man page:
the look on docs.podman.io
Github also adds anchors, see: https://github.com/Luap99/libpod/blob/doc-anchors/docs/source/markdown/podman-attach.1.md