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

[CI:DOCS] Fix Commands table #8331

Closed
wants to merge 1 commit into from
Closed

[CI:DOCS] Fix Commands table #8331

wants to merge 1 commit into from

Conversation

TomSweeneyRedHat
Copy link
Member

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]

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]>
@openshift-ci-robot
Copy link
Collaborator

[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 /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@openshift-ci-robot openshift-ci-robot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Nov 13, 2020
@TomSweeneyRedHat
Copy link
Member Author

@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.

@TomSweeneyRedHat
Copy link
Member Author

Addresses: #8317

@edsantiago
Copy link
Member

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).

@edsantiago
Copy link
Member

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.

@Luap99
Copy link
Member

Luap99 commented Nov 13, 2020

I opened #8335 which address the render problem so we don't have to change the doc format.

@rhatdan
Copy link
Member

rhatdan commented Nov 13, 2020

Closing for #8335

@rhatdan rhatdan closed this Nov 13, 2020
@TomSweeneyRedHat TomSweeneyRedHat deleted the dev/tsweeney/htmlit branch November 13, 2020 13:49
@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 24, 2023
@github-actions github-actions bot locked as resolved and limited conversation to collaborators Sep 24, 2023
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
approved Indicates a PR has been approved by an approver from all required OWNERS files. locked - please file new issue/PR Assist humans wanting to comment on an old issue or PR with locked comments.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants