dynamic-nfs-provisioner icon indicating copy to clipboard operation
dynamic-nfs-provisioner copied to clipboard

docs: updated intro.md to point quickstart users to ebs docs

Open matthew-williams opened this issue 3 years ago • 1 comments

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

Pull Request template

Why is this PR required? What issue does it fix?: Its required cause when you google nfs and k8's this comes up and there are prerequisites not listed in the quickstart guide. What this PR does?: updated intro.md to point quickstart users to ebs docs openebs-hostpath before they get to the troubleshooting docs Does this PR require any upgrade changes?: Nope If the changes in this PR are manually verified, list down the scenarios covered:: No changes to code, just a reduction of confusion. Any additional information for your reviewer? : Mention if this PR is part of any design or a continuation of previous PRs

Checklist:

  • [X ] Fixes #didnt make an issue
  • [X ] PR Title follows the convention of <type>(<scope>): <subject>
  • [ ] Has the change log section been updated? - Havent looked for this, but I can if needed.
  • [ X] Commit has unit tests - None Needed
  • [ X] Commit has integration tests - None Needed
  • [ ] (Optional) Does this PR change require updating NFS-Provisioner Chart? If yes, mention the Helm Chart PR #<PR number>
  • [ ] (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:

PLEASE REMOVE BELOW INFORMATION BEFORE SUBMITTING

The PR title message must follow convention: <type>(<scope>): <subject>.

Where: Most common types are: * feat - for new features, not a new feature for build script * fix - for bug fixes or improvements, not a fix for build script * chore - changes not related to production code * docs - changes related to documentation * style - formatting, missing semi colons, linting fix etc; no significant production code changes * test - adding missing tests, refactoring tests; no production code change * refactor - refactoring production code, eg. renaming a variable or function name, there should not be any significant production code changes * cherry-pick - if PR is merged in master branch and raised to release branch(like v0.4.x)

IMPORTANT: Please review the CONTRIBUTING.md file for detailed contributing guidelines. - Might do.

matthew-williams avatar Jun 08 '22 20:06 matthew-williams

Not Found for the https://github.com/openebs/dynamic-nfs-provisioner/CONTRIBUTING.md

matthew-williams avatar Jun 08 '22 21:06 matthew-williams

@matthew-williams The PR is now picked up for review. The openebs-hostpath is automatically created when the nfs provisioner installation is done via the openebs helm chart. Also, the local(openebs-hostpath) is one of the option that can be used as backend storage class for nfs provisioning, but it can indeed be any other backend as well. cc: @niladrih

dsharma-dc avatar Sep 07 '23 07:09 dsharma-dc

Potential candidate for closing.

dsharma-dc avatar Sep 13 '23 06:09 dsharma-dc

Replaced by #165 with author credits to this PR's author.

dsharma-dc avatar Sep 19 '23 17:09 dsharma-dc