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
Conversation
There was a problem hiding this 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.
docs/HowTo/clusterconnectivity/aiven-kafka-cluster-ssl-protocol.md
Outdated
Show resolved
Hide resolved
docs/HowTo/clusterconnectivity/aiven-kafka-connect-cluster-ssl-protocol.md
Outdated
Show resolved
Hide resolved
docs/HowTo/clusterconnectivity/aiven-karapace-cluster-ssl-protocol.md
Outdated
Show resolved
Hide resolved
docs/HowTo/clusterconnectivity/aiven-karapace-cluster-ssl-protocol.md
Outdated
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. |
There was a problem hiding this comment.
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:
base64 string in the module: cluster-API. | |
base64 string in the module: `cluster-api`. |
93e7c6f
to
3bcdff1
Compare
@programmiri thank you for your review, I've revised according to your comments, review it please |
@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 |
bed0b9b
to
ab9df94
Compare
Awesome, thank you! I just run the github checks. If you check the pipeline, there are three errors left:
|
Signed-off-by: YumeiWang <yumei.wang@mohawkcollege.ca>
Signed-off-by: YumeiWang <yumei.wang@mohawkcollege.ca>
Signed-off-by: YumeiWang <yumei.wang@mohawkcollege.ca>
034f319
to
76f676d
Compare
There was a problem hiding this 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 🎉
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:
Closes #101