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

[BUG]: CSI Specification in documentation causes confusion for some users #210

Closed
gashof opened this issue Mar 2, 2022 · 6 comments
Closed
Assignees
Labels
area/csm-docs Issue pertains to the CSM Documentation type/bug Something isn't working. This is the default label associated with a bug issue.
Milestone

Comments

@gashof
Copy link

gashof commented Mar 2, 2022

Bug Description

Issue:
The "CSI Specification" under CSI Driver Capabilities under Features in the documentation support matrix causes confusion for some users. Details on the CSI Spec are pointed out at the top of the page, but I have seen many users confuse this with the version of the Driver.
https://dell.github.io/csm-docs/docs/csidriver/#csi-driver-capabilities

Part of this confusion is that this page does not show the driver version that Features and Capabilities are for.

Fix:
Note that the CSI Spec is not the driver version and put a link to the Kubernetes CSI spec in the csi-driver-capabilities as well.
Put what version of the drivers the documentations covers on the csi-driver-capabilities page.

Logs

n/a

Screenshots

Available if required

Additional Environment Information

n/a

Steps to Reproduce

n/a

Expected Behavior

n/a

CSM Driver(s)

All CSI Drivers

Installation Type

All Installation Types

Container Storage Modules Enabled

n/a

Container Orchestrator

n/a

Operating System

n/a

@gashof gashof added needs-triage Issue requires triage. type/bug Something isn't working. This is the default label associated with a bug issue. labels Mar 2, 2022
@gallacher gallacher added area/csm-docs Issue pertains to the CSM Documentation and removed needs-triage Issue requires triage. labels Mar 2, 2022
@gallacher gallacher added this to the v1.2.0 milestone Mar 2, 2022
@gallacher
Copy link
Contributor

Thanks for taking the time to report this issue @gashof!

@coulof
Copy link
Collaborator

coulof commented Mar 4, 2022

My 2 cents, let's just scrap the CSI Specification row from : https://dell.github.io/csm-docs/docs/csidriver/#csi-driver-capabilities

The first line of that page gives already the version of the spec we support.

@shanmydell
Copy link
Collaborator

@gashof : Thanks for reporting the issue. As @coulof suggested we are removing the row. This row was introduced when PowerSclae upgraded the spec earlier to support 128 characters, now that all drivers are in same page it is no more needed. This change will be part of our upcoming release

@gashof
Copy link
Author

gashof commented Mar 7, 2022

Hi,
Anything on this point:
Put what version of the drivers the documentations covers on the csi-driver-capabilities page.

@shanmydell
Copy link
Collaborator

@gallacher and @coulof : Please let me know your thoughts on @gashof request. Shall we add the version of driver in CSI driver index page , we already have it in CSM home page but not in driver page index

@shanmydell shanmydell reopened this Mar 7, 2022
@gallacher
Copy link
Contributor

The requested changes have been made and will be available as part of the CSM v1.2.0 release.

@gallacher gallacher changed the title [BUG]: Doc bug; CSI Specification causes confusion for some users. [BUG]: CSI Specification in documentation causes confusion for some users. Mar 10, 2022
@gallacher gallacher changed the title [BUG]: CSI Specification in documentation causes confusion for some users. [BUG]: CSI Specification in documentation causes confusion for some users Mar 21, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/csm-docs Issue pertains to the CSM Documentation type/bug Something isn't working. This is the default label associated with a bug issue.
Projects
None yet
Development

No branches or pull requests

4 participants