Fix typos on docs #594
Fix typos on docs #594
Conversation
karmada-bot
added
the
kind/documentation
karmada-bot
added
the
size/XS
cc @zhzhuang-zju to take a look at the DCO. /assign @windsonsea |
@LavredisG The error mssg of DCO is 'Commit sha: 92f02a2, Author: LavredisG, Committer: GitHub; Expected "LavredisG [email protected]", but got "LavredisG [email protected]".', which looks like a mailbox problem |
|
How to fix it? |
The DCO check should be fine, so @LavredisG need to set github settings related to email address, which can be found at https://docs.github.com/en/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-email-preferences/adding-an-email-address-to-your-github-account |
|
Normally we only need to commit again like: If it doesn't work, you may need to follow #594 (comment) |
Thanks a lot! I never noticed it. |
|
Hi @LavredisG Looks like the DCO failed for the same reason. Have you tried the methods mentioned in #594 (comment) and #594 (comment)? Looking forward to your feedback~ |
I changed the email settings, the issue was due to the fact that I had enabled privacy email. My guess is that DCO has kept the mail that initiated the PR as the one it expects, so I will close this and retry once I am available. |
docs/core-concepts/concepts.md
Outdated
|
|
||
| - Support 1:n mapping of policy: workload. Users don't need to indicate scheduling constraints every time creating federated applications. | ||
| - Support 1:n mapping of policy:workload. Users don't need to indicate scheduling constraints every time creating federated applications. |
There was a problem hiding this comment.
@LavredisG Thanks for your work! Curious to ask：
- What are the norms for whether to add spaces before and after punctuation marks in English documents?
- Did you scan these "problem" with a tool?
- I observed that the
websiterepo has acifor checking typo, does it cover these "problems"?
There was a problem hiding this comment.
- Regarding parentheses and brackets, "a space should be added before the opening parenthesis or bracket, but not before the closing parenthesis or bracket".
- No, I found them while reading the docs for my understading.
- I hadn't check the ci, it seems that it checks for typos rather than correct punctuation. Also, words such as "Karmada" aren't typical English words, so the Karamda typo would go unchecked.
docs/core-concepts/concepts.md
Outdated
|
|
||
| - Support 1:n mapping of policy: workload. Users don't need to indicate scheduling constraints every time creating federated applications. | ||
| - Support 1:n mapping of policy:workload. Users don't need to indicate scheduling constraints every time creating federated applications. |
There was a problem hiding this comment.
| - Support 1:n mapping of policy:workload. Users don't need to indicate scheduling constraints every time creating federated applications. | |
| - Support 1:n mapping of policy:workloads. Users don't need to indicate scheduling constraints every time creating federated applications. |
How about appending the suffix s, so policy:workloads has a consistent pattern with 1:n?
Signed-off-by: LavredisG <[email protected]>
|
@LavredisG Glad to see you solved the DCO issue. Would you be able to tell how you solved the problem? That way if other contributors run into the same problem in the future, they'll have a good example of how to fix it! |
Sure, I have already written it in the PR's description, but I will add it here for readability too: "Error: DCO keeps failing despite the sign-off being included in the commit message. Fix: after removing privacy option from github email, git cache (not github) had to be updated to reflect the changes." |
|
[APPROVALNOTIFIER] This PR is APPROVED This pull-request has been approved by: RainbowMango The full list of commands accepted by this bot can be found here. The pull request process is described here
Needs approval from an approver in each of these files:
Approvers can indicate their approval by writing |
karmada-bot
added
the
approved
DCO keeps failing despite the sign-off being included in the commit message.
Fix: after removing privacy option from github email, git cache had to be updated to reflect the changes.