zfs-localpv icon indicating copy to clipboard operation
zfs-localpv copied to clipboard

docs: Fix resources comments order in helm chart

Open pando85 opened this issue 11 months ago • 2 comments

Pull Request template

Please, go through these steps before you submit a PR.

Why is this PR required? What issue does it fix?: Fix helm docs.

What this PR does?:

Does this PR require any upgrade changes?:

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
  • [ ] Commit has integration tests
  • [ ] (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:

  • type is defining if release will be triggering after merging submitted changes, details in CONTRIBUTING.md. 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
  • scope is a single word that best describes where the changes fit. Most common scopes are like:

    • data engine (localpv, jiva, cstor)
    • feature (provisioning, backup, restore, exporter)
    • code component (api, webhook, cast, upgrade)
    • test (tests, bdd)
    • chores (version, build, log, travis)
  • subject is a single line brief description of the changes made in the pull request.

pando85 avatar Mar 06 '24 16:03 pando85

@pando85 -- Why is this change required?

niladrih avatar Mar 22 '24 05:03 niladrih

To fix the resources key comments.

pando85 avatar Mar 22 '24 05:03 pando85

@pando85 Can you please explain the changes in the PR description.

Abhinandan-Purkait avatar May 22 '24 06:05 Abhinandan-Purkait

I think that the diff is pretty clear. There are an error with the order of the commented resources values.

pando85 avatar May 22 '24 06:05 pando85

I think that the diff is pretty clear. There are an error with the order of the commented resources values.

Yeah we can see the diff. Please update that in the description. The description has no information about the PR.

Abhinandan-Purkait avatar May 22 '24 07:05 Abhinandan-Purkait