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.

Sign up for GitHub

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

Jump to bottom

doc: Clarify default values for mountOptions and mkfsOptions in storageclass example #4197

Merged
merged 1 commit into from Oct 20, 2023
Merged

doc: Clarify default values for mountOptions and mkfsOptions in storageclass example #4197

merged 1 commit into from Oct 20, 2023

Conversation

MaGaroo
Copy link
Contributor

@MaGaroo MaGaroo commented Oct 16, 2023

Describe what this PR does

I thought the example comments are a bit misleading in case of mountOptions and mkfsOptions. I tried to clarify it based on the code in here

Is there anything that requires special attention

Do you have any questions? No

Is the change backward compatible? Yes

Are there concerns around backward compatibility? No

Related issues

N/A

Future concerns

N/A

@MaGaroo MaGaroo changed the title Clarify default values for mountOptions and mkfsOptions default value Clarify default values for mountOptions and mkfsOptions in storageclass example Oct 16, 2023
@MaGaroo MaGaroo force-pushed the improve-example-storageclass branch from fe905b9 to 7468b5d Compare October 16, 2023 19:41
@nixpanic nixpanic changed the title Clarify default values for mountOptions and mkfsOptions in storageclass example doc: Clarify default values for mountOptions and mkfsOptions in storageclass example Oct 17, 2023
@mergify mergify bot added ci/skip/e2e skip running e2e CI jobs ci/skip/multi-arch-build skip building on multiple architectures component/docs Issues and PRs related to documentation labels Oct 17, 2023
@nixpanic
Copy link
Member

Thanks for the PR!

Please update the commit message to have short subject with doc: prefix, maybe something like this:

doc: improve comment for mountOptions and mkfsOptions in StorageClass example

A more complete description can be added to a paragraph in the commit message if you like.

Make sure to add your Signed-off-by: tag with real name and email address as well.

More details about the expected format of commit messages can be found in the Development Guide.

@MaGaroo MaGaroo force-pushed the improve-example-storageclass branch from 7468b5d to ca90598 Compare October 17, 2023 21:09
@MaGaroo
Copy link
Contributor Author

MaGaroo commented Oct 17, 2023

Thank you @nixpanic for your review.
I applied your suggestions.

@nixpanic nixpanic requested a review from a team October 20, 2023 09:02
@nixpanic
Copy link
Member

@Mergifyio queue

@mergify
Copy link
Contributor

mergify bot commented Oct 20, 2023 •
edited

queue

🛑 The pull request has been removed from the queue default

Pull request #4197 has been dequeued due to failing checks or checks timeout.

You can take a look at Queue: Embarked in merge queue check runs for more details.

In case of a failure due to a flaky test, you should first retrigger the CI.
Then, re-embark the pull request into the merge queue by posting the comment
@mergifyio refresh on the pull request.

@nixpanic
Copy link
Member

@Mergifyio rebase

@MaGaroo @nixpanic
doc: improve comments in StorageClass example
0a67d87 
The comments of mkfsOptions and mountOptions are
modified to match the real behavior of the code.

Signed-off-by: Majid Garoosi <amoomajid99@gmail.com>
@mergify
Copy link
Contributor

mergify bot commented Oct 20, 2023

rebase

✅ Branch has been successfully rebased

@nixpanic
Copy link
Member

@Mergifyio queue

@mergify
Copy link
Contributor

mergify bot commented Oct 20, 2023 •
edited

queue

✅ The pull request has been merged automatically

The pull request has been merged automatically at edb065b

@mergify mergify bot added the ok-to-test Label to trigger E2E tests label Oct 20, 2023
@ceph-csi-bot
Copy link
Collaborator

/test ci/centos/k8s-e2e-external-storage/1.26

@ceph-csi-bot
Copy link
Collaborator

/test ci/centos/upgrade-tests-cephfs

@ceph-csi-bot
Copy link
Collaborator

/test ci/centos/mini-e2e-helm/k8s-1.26

@ceph-csi-bot
Copy link
Collaborator

/test ci/centos/k8s-e2e-external-storage/1.28

@ceph-csi-bot
Copy link
Collaborator

/test ci/centos/k8s-e2e-external-storage/1.27

@ceph-csi-bot
Copy link
Collaborator

/test ci/centos/upgrade-tests-rbd

@ceph-csi-bot
Copy link
Collaborator

/test ci/centos/mini-e2e/k8s-1.26

@ceph-csi-bot
Copy link
Collaborator

/test ci/centos/mini-e2e-helm/k8s-1.28

@ceph-csi-bot
Copy link
Collaborator

/test ci/centos/mini-e2e-helm/k8s-1.27

@ceph-csi-bot
Copy link
Collaborator

/test ci/centos/mini-e2e/k8s-1.28

@ceph-csi-bot
Copy link
Collaborator

/test ci/centos/mini-e2e/k8s-1.27

@ceph-csi-bot ceph-csi-bot removed the ok-to-test Label to trigger E2E tests label Oct 20, 2023
@mergify mergify bot merged commit edb065b into ceph:devel Oct 20, 2023
34 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@nixpanic nixpanic nixpanic approved these changes

@riya-singhal31 riya-singhal31 riya-singhal31 approved these changes

Assignees
No one assigned
Labels
ci/skip/e2e skip running e2e CI jobs ci/skip/multi-arch-build skip building on multiple architectures component/docs Issues and PRs related to documentation
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

None yet
4 participants
@MaGaroo @nixpanic @ceph-csi-bot @riya-singhal31