Skip to content
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

RFE: anchors in docs.podman.io's man pages would be nice to have #7300

Closed
TomSweeneyRedHat opened this issue Aug 11, 2020 · 9 comments · Fixed by #8292
Closed

RFE: anchors in docs.podman.io's man pages would be nice to have #7300

TomSweeneyRedHat opened this issue Aug 11, 2020 · 9 comments · Fixed by #8292
Assignees
Labels
In Progress This issue is actively being worked by the assignee, please do not work on this at this time. kind/documentation Categorizes issue or PR as related to documentation. kind/feature Categorizes issue or PR as related to a new feature. locked - please file new issue/PR Assist humans wanting to comment on an old issue or PR with locked comments. stale-issue

Comments

@TomSweeneyRedHat
Copy link
Member

I'm not sure it is possible, or easily doable, but it would be nice to have anchors on the man pages that are shown in docs.podman.io. For instance, I was reviewing @ashley-cui 's blog on timezones and I wanted to link to the tz option there, with something like: http://docs.podman.io/en/latest/markdown/podman-run.1.html#--tz but I could not. I had to use a link to the top of the page, and it's a long scroll down.

@ashley-cui
Copy link
Member

ashley-cui commented Aug 11, 2020

It looks like you can link headers automatically but not content inside the headers, which is seems to be a markdown standard? Otherwise, you can definitely do them, I know regular HTML anchors work on markdown, but you would need to create an anchor for each flag which may be super annoying. Might be a better way, but this is as much as I know now :)

@mheon mheon added the kind/documentation Categorizes issue or PR as related to documentation. label Sep 9, 2020
@rhatdan
Copy link
Member

rhatdan commented Oct 5, 2020

@TomSweeneyRedHat @ashley-cui Any movement on this?

@TomSweeneyRedHat
Copy link
Member Author

I believe it's been smoldering in the background, but still a nice to have.

@rhatdan rhatdan added the kind/feature Categorizes issue or PR as related to a new feature. label Oct 7, 2020
@github-actions
Copy link

github-actions bot commented Nov 7, 2020

A friendly reminder that this issue had no activity for 30 days.

@rhatdan
Copy link
Member

rhatdan commented Nov 7, 2020

@TomSweeneyRedHat @ashley-cui Is this something you think we will ever have? Or should I close the issue?

@TomSweeneyRedHat
Copy link
Member Author

@rhatdan I'd love to have it, just a matter of time. I'd leave it in hopes someone will grab it and run with it.

@rhatdan
Copy link
Member

rhatdan commented Nov 8, 2020

I have just read up on this. So you want to take each option and make them into a link
Something like?

[**--tz**=*timezone*](#--tz)

Sadly gomd2man makes the man page look like

man podman-create
...
       --tz=timezone ⟨#--tz⟩

@TomSweeneyRedHat
Copy link
Member Author

Honestly, I've not dived into the syntax that's needed to make it happen, but the end result would be something like what we have on podman.io that @Luap99 (I think) did for us. I'm not sure if he's a thought or three on this. So the end result is you'd see a little link symbol next to the titles in the online man page, and whecn clicked on you'd get something like: https://podman.io/#podman-has-gone-210

@Luap99
Copy link
Member

Luap99 commented Nov 10, 2020

I will take a look.

@Luap99 Luap99 self-assigned this Nov 10, 2020
@Luap99 Luap99 added the In Progress This issue is actively being worked by the assignee, please do not work on this at this time. label Nov 10, 2020
@github-actions github-actions bot added the locked - please file new issue/PR Assist humans wanting to comment on an old issue or PR with locked comments. label Sep 22, 2023
@github-actions github-actions bot locked as resolved and limited conversation to collaborators Sep 22, 2023
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
In Progress This issue is actively being worked by the assignee, please do not work on this at this time. kind/documentation Categorizes issue or PR as related to documentation. kind/feature Categorizes issue or PR as related to a new feature. locked - please file new issue/PR Assist humans wanting to comment on an old issue or PR with locked comments. stale-issue
Projects
None yet
Development

Successfully merging a pull request may close this issue.

5 participants