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: Enhance user-initiated checks in Volume management, Upgrade, and Downgrade procedures #3185

Open
gdemonet opened this issue Mar 10, 2021 · 0 comments
Labels
complexity:medium Something that requires one or few days to fix kind:enhancement New feature or request topic:docs Documentation

Comments

@gdemonet
Copy link
Contributor

Component: docs

Why this is needed:

Sometimes, provided checks are not sufficient to ensure a procedure successfully completed.

For instance, in the CLI Volume creation procedure, we only suggest to check if the Volume object exists in the API, but we don't provide anything to validate that the provisioning succeeded/failed, or how to troubleshoot errors if any.

What should be done:

  • Review the existing procedures to add any useful missing check
  • Review the test implementations to make sure they are not relying on "internal" checks when documented ones would be sufficient (we mainly want to ensure user-facing functionality behaves as documented)
@gdemonet gdemonet added kind:enhancement New feature or request topic:docs Documentation complexity:medium Something that requires one or few days to fix labels Mar 10, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
complexity:medium Something that requires one or few days to fix kind:enhancement New feature or request topic:docs Documentation
Projects
None yet
Development

No branches or pull requests

1 participant