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

docs: Various doc improvements #526

Merged
merged 2 commits into from
May 17, 2024
Merged

docs: Various doc improvements #526

merged 2 commits into from
May 17, 2024

Conversation

PaulYuuu
Copy link
Contributor

@PaulYuuu PaulYuuu commented May 14, 2024

  1. Correct a typo in bootc-install-config.md
  2. Keep the same format for man usage
  3. Remove ".md" suffix in some man description
  4. Add missing "bootc-install-to-existing-root"

@PaulYuuu
Copy link
Contributor Author

Hello maintainers, I also have a question, is docs/src/bootc.md still used? I checked the mdbook will use docs/src/man/bootc.md, and docs/src/bootc.md is missing the bootc-rollback subcommand.

Copy link
Collaborator

@cgwalters cgwalters left a comment

Choose a reason for hiding this comment

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

First part looks good!

docs/src/man/bootc-edit.md Outdated Show resolved Hide resolved
docs/src/man-md/bootc-install-config.md Show resolved Hide resolved
@cgwalters
Copy link
Collaborator

Looks like this needs a rebase 🏄 now too

Signed-off-by: Yihuang Yu <yihyu@redhat.com>
1. Keep the same format for man usage
2. Remove ".md" suffix in some man description
3. Add missing "bootc-install-to-existing-root"

Signed-off-by: Yihuang Yu <yihyu@redhat.com>
@PaulYuuu
Copy link
Contributor Author

Thank you @cgwalters, I rebased to the latest main branch, please help to check.

Also, I think I have a way how to disable the version option for subcommand and another update, I will try to submit another one.

@cgwalters cgwalters merged commit 7700626 into containers:main May 17, 2024
15 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants