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 indentation for userns modes #11368

Merged
merged 1 commit into from
Sep 1, 2021

Conversation

giuseppe
Copy link
Member

Closes: #11364

Signed-off-by: Giuseppe Scrivano [email protected]

@openshift-ci
Copy link
Contributor

openshift-ci bot commented Aug 31, 2021

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: giuseppe

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 openshift-ci bot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Aug 31, 2021
@mheon
Copy link
Member

mheon commented Aug 31, 2021

LGTM

@vrothberg vrothberg changed the title docs: fix indentation for userns modes [CI:DOCS] fix indentation for userns modes Aug 31, 2021
@vrothberg
Copy link
Member

@giuseppe, could you repush? The deadlock is hitting us again.

Copy link
Member

@vrothberg vrothberg left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@eriksjolund
Copy link
Contributor

The auto options could also be indented to make it clear that they only belong to the auto keyword:

https://github.com/eriksjolund/podman/blob/fix_userns_doc/docs/source/markdown/podman-run.1.md#--usernsmode

@eriksjolund
Copy link
Contributor

eriksjolund commented Aug 31, 2021

Aha, I think the layout change was aiming to remove the outer bullet list (but forgot keep-id, ns and private)

https://github.com/eriksjolund/podman/blob/fix_userns_doc_adjust_keep-id_ns_private/docs/source/markdown/podman-run.1.md#--usernsmode

My preference would be a two-level bullet list:

https://github.com/eriksjolund/podman/blob/fix_userns_doc/docs/source/markdown/podman-run.1.md#--usernsmode

or alternatively to lift out the inner bullet list (i.e. the auto options) and put it as a separate section after the section that lists all --userns options.

Something like this:
https://github.com/eriksjolund/podman/blob/fix_userns_doc_move_auto_option_documentation/docs/source/markdown/podman-run.1.md#--usernsmode

@rhatdan
Copy link
Member

rhatdan commented Sep 1, 2021

Test failures, have nothing to do with this PR. Forcing merge.

@rhatdan rhatdan merged commit c363223 into containers:main Sep 1, 2021
@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
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.

--userns documentation markdown layout issue
5 participants