Skip to content

chore(docs): Advisory to install backend storage class#165

Merged
dsharma-dc merged 2 commits intodevelopfrom
doc_update
Sep 19, 2023
Merged

chore(docs): Advisory to install backend storage class#165
dsharma-dc merged 2 commits intodevelopfrom
doc_update

Conversation

@dsharma-dc
Copy link
Copy Markdown
Contributor

Pull Request template

Why is this PR required? What issue does it fix?:
Documentation update.
What this PR does?:
Advises users to complete installation of a backend storage class.
Does this PR require any upgrade changes?:
No
If the changes in this PR are manually verified, list down the scenarios covered::

Any additional information for your reviewer? :
Mention if this PR is part of any design or a continuation of previous PRs

Checklist:

  • Fixes #
  • PR Title follows the convention of <type>(<scope>): <subject>
  • Has the change log section been updated?
  • Commit has unit tests - N/A
  • Commit has integration tests -N/A
  • (Optional) Does this PR change require updating NFS-Provisioner Chart? If yes, mention the Helm Chart PR #
  • (Optional) Are upgrade changes included in this PR? If not, mention the issue/PR to track:
  • (Optional) If documentation changes are required, which issue on https://github.com/openebs/openebs-docs is used to track them:

adding a link to https://openebs.io/docs/user-guides/localpv-hostpath so people that just find this guide know why it didnt work.

Signed-off-by: Diwakar Sharma <diwakar.sharma@datacore.com>
@dsharma-dc dsharma-dc requested a review from niladrih September 19, 2023 17:09
@dsharma-dc dsharma-dc changed the title Doc update chore(docs): Advisory to install backend storage class Sep 19, 2023
Copy link
Copy Markdown
Member

@niladrih niladrih left a comment

Choose a reason for hiding this comment

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

Nitpick

docs/intro.md Outdated

1. Kubernetes version 1.18
2. NFS Client is installed on all nodes that will run a pod that mounts an `openebs-rwx` volume.
2. This guide assumes you have completed installation of a backend storage class provisioner e.g : https://openebs.io/docs/user-guides/localpv-hostpath
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Suggested change
2. This guide assumes you have completed installation of a backend storage class provisioner e.g : https://openebs.io/docs/user-guides/localpv-hostpath
2. This guide assumes you have completed installation of a backend storage class provisioner (e.g: https://openebs.io/docs/user-guides/localpv-hostpath)

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

fixed

Signed-off-by: Diwakar Sharma <diwakar.sharma@datacore.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants