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: restructure references #461

Merged
merged 14 commits into from
Aug 5, 2024

Conversation

IronCore864
Copy link
Contributor

@IronCore864 IronCore864 commented Aug 1, 2024

Some structural changes to the reference docs.

Changes:

  • Remove duplicated commands from subdirectories in the reference, and move the examples in them to cli-commands.
  • Remove directories "notices", "changes-and-tasks", "pebble-in-containers", change them into a single page under "reference".
  • Update broken links because of the above structural changes.
  • Set terminal width to a fixed length so that the actual terminal width where the script is running won't affect the help command output width.

@IronCore864 IronCore864 marked this pull request as ready for review August 1, 2024 06:53
Copy link
Contributor

@AnneCYH AnneCYH left a comment

Choose a reason for hiding this comment

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

Hi @IronCore864 , some minor comments.
Am just focusing on the intended scope of this PR.

@AnneCYH
Copy link
Contributor

AnneCYH commented Aug 1, 2024

Hey @IronCore864 , some general feedback.

The cmd pages should link back to the parent reference page, where available.
E.g. notices CLI pages should link back to the Notices reference doc.

But it can be an enhancement.

@IronCore864
Copy link
Contributor Author

Hey @IronCore864 , some general feedback.

The cmd pages should link back to the parent reference page, where available. E.g. notices CLI pages should link back to the Notices reference doc.

But it can be an enhancement.

Thanks for the advice, I just added them in this PR since it's only adding a line and it's related to the moved content anyway.

docs/reference/cli-commands/notice.md Outdated Show resolved Hide resolved
docs/reference/cli-commands/tasks.md Outdated Show resolved Hide resolved
Copy link
Contributor

@benhoyt benhoyt left a comment

Choose a reason for hiding this comment

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

Looks good to me, thanks. I also tweaked the pebble run and pebble warnings help descriptions to be wrapped to 80 columns manually -- it's a bit unfortunate these use a fixed wrapping and the args help uses an automatic wrapping, but oh well. This is good enough for now.

@IronCore864 IronCore864 merged commit 1f50b01 into canonical:master Aug 5, 2024
16 checks passed
@IronCore864 IronCore864 deleted the docs-restructure-references branch August 5, 2024 08:38
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.

3 participants