-
Notifications
You must be signed in to change notification settings - Fork 2.4k
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] Fix Commands table #8331
[CI:DOCS] Fix Commands table #8331
Conversation
The markdown table that lists all of the available commands on the toplevel Podman man page does not resolve correctly when converted to html and moved to docs.podman.io. So as html is valid in a markdown document, I've converted the table to use html instead in hope that it will translate better. Signed-off-by: TomSweeneyRedHat <[email protected]>
[APPROVALNOTIFIER] This PR is APPROVED This pull-request has been approved by: TomSweeneyRedHat 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 |
@edsantiago PTAL. I have a thought that you have a test that runs through this table to validate man pages. Please let me know if this change messes that up or not. |
Addresses: #8317 |
Yeah, that's going to fail Validate. BTW there are several other man pages that include tables and might also be having problems: basically, any subcommand (podman image X, podman container X). |
So, if I may add my humble two cents: I think this is the wrong approach. The new form is unmaintainable, I'd even go as far as saying anti-maintainable. It is the opposite of what markdown is intended to provide. It's also not going to work that well with plaintext manpages. IIUC the problem we are trying to solve is that some HTML pages look icky. Is that correct? If so, I would encourage us to take a step back, not break the markdown pages which have been working remarkably well for us so far, and try to look for a solution closer to the problem itself. How are the web pages in question generated? What are the tools? Do they have an option for generating HTML tables from markdown ones? (i.e. this has to be an already-solved problem that we can piggyback on). If there's no way: can we insert filters? Can we add a sed or perl filter that translates markdown tables into HTML tags? I'm reluctant to spend my evening on this, and I have a hard commitment tomorrow. I'm sorry. I do hope we can find a less disruptive, more maintainable solution. |
I opened #8335 which address the render problem so we don't have to change the doc format. |
Closing for #8335 |
The markdown table that lists all of the available commands
on the toplevel Podman man page does not resolve correctly
when converted to html and moved to docs.podman.io.
So as html is valid in a markdown document, I've converted
the table to use html instead in hope that it will translate better.
Signed-off-by: TomSweeneyRedHat [email protected]