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

Update the output of k0s config create in the docs #2528

Merged
merged 1 commit into from
Dec 20, 2022

Conversation

twz123
Copy link
Member

@twz123 twz123 commented Dec 16, 2022

Description

So that the docs better reflect the actual output of the subcommand. This boils mostly down to alphabetic ordering, retaining some cosmetic differences to the actual output:

  • omit the metadata.creationTimestamp field
  • retain the exemplary spec.api.externalAddress field
  • move spec.images.default_pull_policy to the top, so it doesn't get visually lost in the list of images.

Also: Adjust some whitespace to properly align some Markdown tables.

Type of change

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • Documentation update

How Has This Been Tested?

  • Manual test
  • Auto test added

Checklist:

  • My code follows the style guidelines of this project
  • My commit messages are signed-off
  • I have performed a self-review of my own code
  • I have commented my code, particularly in hard-to-understand areas
  • I have made corresponding changes to the documentation
  • My changes generate no new warnings
  • I have added tests that prove my fix is effective or that my feature works
  • New and existing unit tests pass locally with my changes
  • Any dependent changes have been merged and published in downstream modules
  • I have checked my code and corrected any misspellings

So that the docs better reflect the actual output of the subcommand.
This boils mostly down to alphabetic ordering, retaining some cosmetic
differences to the actual output:

* omit the metadata.creationTimestamp field
* retain the exemplary spec.api.externalAddress field
* move spec.images.default_pull_policy to the top, so it doesn't get
  visually lost in the list of images.

Also: Adjust some whitespace to properly align some Markdown tables.

Signed-off-by: Tom Wieczorek <[email protected]>
@twz123 twz123 added documentation Improvements or additions to documentation chore labels Dec 16, 2022
@twz123 twz123 requested a review from a team as a code owner December 16, 2022 13:48
@twz123 twz123 requested review from ncopa and jnummelin December 16, 2022 13:48
@twz123 twz123 merged commit 8dfae86 into k0sproject:main Dec 20, 2022
@twz123 twz123 deleted the update-docs-k0s-config-create branch January 12, 2023 10:59
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
chore documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants