openshift / openshift/oadp-operator
csi_example.md needs updating and hyperlink example yamls.
Nobody has claimed this yet.
- Dominant language
- Go
- Stars
- 92
- Forks
- 93
- Avg merge
- 1d 23h
- Merged PRs (30d)
- 43
Description
Is your feature request related to a problem? Please describe.
https://github.com/openshift/oadp-operator/blob/master/docs/examples/CSI/csi_example.md is out of date
namely csi plugin is still in defaultPlugins
and manifest examples (manually) point to a symlink that do not exists any longer or was renamed. need to hyperlink to make it easier to navigate.
Describe the solution you'd like
Describe alternatives you've considered
Additional context
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Open docs/examples/CSI/csi_example.md and review the CSI plugin entry in defaultPlugins and the manifest examples. Check each referenced symlink or path and replace the broken or outdated references with hyperlinks to the current examples. Done means the CSI documentation is current and the example links navigate to existing files.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 1/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100