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 and enhance reset docs #4214

Merged
merged 1 commit into from
Mar 28, 2024
Merged

Conversation

twz123
Copy link
Member

@twz123 twz123 commented Mar 28, 2024

Description

The console snippets were seriously out of date. Update them to reflect the current state of affairs. While at it, add a comprehensive description about the reset command and its purpose, along with a warning that it will obviously erase data.

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

The console snippets were seriously out of date. Update them to
reflect the current state of affairs. While at it, add a comprehensive
description about the reset command and its purpose, along with a
warning that it will obviously erase data.

Signed-off-by: Tom Wieczorek <[email protected]>
@twz123 twz123 added the documentation Improvements or additions to documentation label Mar 28, 2024
@twz123 twz123 requested a review from a team as a code owner March 28, 2024 11:16
@twz123 twz123 requested review from ncopa and juanluisvaladas March 28, 2024 11:16
@twz123 twz123 merged commit 21030c2 into k0sproject:main Mar 28, 2024
8 checks passed
@twz123 twz123 deleted the update-reset-docs branch March 28, 2024 13:21
@twz123 twz123 added the backport/release-1.29 PR that needs to be backported/cherrypicked to the release-1.29 branch label Dec 9, 2024
@k0s-bot
Copy link

k0s-bot commented Dec 9, 2024

Successfully created backport PR for release-1.29:

@twz123
Copy link
Member Author

twz123 commented Dec 9, 2024

Backporting this as preparation for a backport of #5300.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
backport/release-1.29 PR that needs to be backported/cherrypicked to the release-1.29 branch documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants