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.

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

use term "API" correctly #136

Merged
merged 4 commits into from Oct 13, 2023
Merged

Conversation

WangGithub0
Copy link
Contributor

Cut and past the line related to API ("(?i)api") from branding-warning-temp.yml and add it to branding.yaml
Run npm run spell:error and revise all the wrong uses according to the result.

After revising, no errors:
image

Closes #101

Copy link
Contributor

@programmiri programmiri left a comment

Choose a reason for hiding this comment

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

Hi! Thanks for your PR 🙏

I left some comments, where the capitalisation was not needed, but a different format. We migrated the documentation from a different documentation framwork and there are still some wrong formattings in here, that now you PR surfaced.

I left suggestions on all of those places, you can apply them directly if you want to, that should make it faster for you.

.github/vale/styles/Klaw/branding.yml Show resolved Hide resolved
@@ -28,7 +28,7 @@ the source.
- Configure the property `klaw.clusterapi.access.base64.secret` in the `application.properties` file with a base64
string in the module: core.
- Configure the property `klaw.clusterapi.access.base64.secret` in the `application.properties` file with the above
base64 string in the module: cluster-api.
base64 string in the module: cluster-API.
Copy link
Contributor

Choose a reason for hiding this comment

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

This should be formatted as code:

Suggested change
base64 string in the module: cluster-API.
base64 string in the module: `cluster-api`.

docs/HowTo/installation/run-source.md Outdated Show resolved Hide resolved
docs/Releases/release110.md Outdated Show resolved Hide resolved
docs/Releases/release250.md Outdated Show resolved Hide resolved
docs/Releases/release251.md Outdated Show resolved Hide resolved
@WangGithub0
Copy link
Contributor Author

@programmiri thank you for your review, I've revised according to your comments, review it please

@programmiri
Copy link
Contributor

@WangGithub0 great job, thanks a bunch 🎉 I left one comment where there's still one formatting issue left.

Also, could you check that the rule is in the branding.yml file? I'm not sure if GitHub is showing me the changes incorrectly, but based on the diff view here it's now removed von the branding-warning-temp file (which is great!) but seems not to be in the branding file, where it has to be in order to be checked as an error.

@programmiri
Copy link
Contributor

Awesome, thank you!

I just run the github checks. If you check the pipeline, there are three errors left:

  • One is a formatting error (that I also didn't catch in the review :D good thing we have the pipeline!)
  • Of of them seems to be caused by a link where there is a space between the [ ] and ( ), so Vale does not recognize it as an error
  • The last one is coming form a different rule that was implemented in the meantime.

Signed-off-by: YumeiWang <yumei.wang@mohawkcollege.ca>
Signed-off-by: YumeiWang <yumei.wang@mohawkcollege.ca>
Signed-off-by: YumeiWang <yumei.wang@mohawkcollege.ca>
Signed-off-by: YumeiWang <yumei.wang@mohawkcollege.ca>
Copy link
Contributor

@programmiri programmiri left a comment

Choose a reason for hiding this comment

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

Awesome @WangGithub0, great job :) I'm going to merge now. We appreciate your contribution 🎉

@programmiri programmiri merged commit b5ce337 into Aiven-Open:main Oct 13, 2023
4 checks passed
@WangGithub0 WangGithub0 deleted the issue-101 branch October 13, 2023 12:46
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Update docs to use the term "API" correctly
3 participants