Skip to content

docs: Enhance user-initiated checks in Volume management, Upgrade, and Downgrade procedures #3185

Open
@gdemonet

Description

@gdemonet

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)

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions