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: Improve troubleshooting docs on restoring CRDs after deletion #11154

Merged

Conversation

alexander-bauer
Copy link
Contributor

@alexander-bauer alexander-bauer commented Oct 16, 2022

Description of your changes: These changes make substantial improvements on the Troubleshooting -> Restoring CRDs After Deletion document. The currently published docs are incomplete. This updates them to include instructions surrounding the ValidatingWebhookConfiguration, and replaces interactive steps with commands. Additionally, some whitespace issues affecting the markdown parsing of the numbered lists have been fixed.

Which issue is resolved by this Pull Request: NA

Checklist:

  • Commit Message Formatting: Commit titles and messages follow guidelines in the developer guide).
  • Skip Tests for Docs: If this is only a documentation change, add the label skip-ci on the PR.
  • Reviewed the developer guide on Submitting a Pull Request
  • Pending release notes updated with breaking and/or notable changes for the next minor release.
  • Documentation has been updated, if necessary.
  • Unit tests have been added, if necessary.
  • Integration tests have been added, if necessary.

@alexander-bauer
Copy link
Contributor Author

I don't believe I'm able to add the skip-ci label on this PR. If I am, and I'm just missing it, sorry.

This commit adjusts spacing in the Docs -> Troubleshooting -> Disaster
Recovery -> Restoring CRDs after Deletion sources to repair
list-numbering-mangling. The section is altered to use spacing
suggestions from:
  https://squidfunk.github.io/mkdocs-material/reference/lists/

Signed-off-by: Alexander Bauer <sasha@linux.com>
@alexander-bauer alexander-bauer force-pushed the docs-restoring-crds-after-deletion branch from 3c8ff10 to 3292e28 Compare October 16, 2022 02:57
Copy link
Member

@travisn travisn left a comment

Choose a reason for hiding this comment

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

Looks great, thanks for improving this doc! Just a tiny suggestion on the note format

Documentation/Troubleshooting/disaster-recovery.md Outdated Show resolved Hide resolved
@alexander-bauer
Copy link
Contributor Author

Just applied that note style change, thank you! I replaced the original commit which added it, and pushed a new pair of commits.

Signed-off-by: Alexander Bauer <sasha@linux.com>
Signed-off-by: Alexander Bauer <sasha@linux.com>
@alexander-bauer alexander-bauer force-pushed the docs-restoring-crds-after-deletion branch from 14cf27b to 825e956 Compare October 19, 2022 23:57
Copy link
Member

@travisn travisn left a comment

Choose a reason for hiding this comment

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

The krew plugin could automate all of this, opened an issue: rook/kubectl-rook-ceph#68

@travisn travisn merged commit aa91691 into rook:master Oct 21, 2022
travisn added a commit that referenced this pull request Oct 24, 2022
Docs: Improve troubleshooting docs on restoring CRDs after deletion (backport #11154)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants