-
Notifications
You must be signed in to change notification settings - Fork 2.7k
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
Standardize capitalization of key proper nouns in Quarkus documentation #37868
Comments
Hey @rolfedh , Do you have examples in mind? Also, I think we need to discuss this as a community before including things in guidelines. |
/cc @ebullient (documentation), @inoxx03 (documentation), @michelle-purcell (documentation), @sunayna15 (documentation) |
Thank you for your feedback, @gsmet. I agree that we need to discuss this as a community before including things in our guidelines. The intention of creating this issue is to start a conversation and gather input from other contributors. I will bring it up in an upcoming team meeting and see what others think.
Please let me know if you have any questions or suggestions. I appreciate your help and collaboration. 😊 |
To managage and discuss the full list of terms, let's use the "Upstream terms for discussion" tab of the Quarkus Terminology spreadsheet. |
Description
Description
Our documentation frequently references specific proper nouns that are integral to Quarkus and its ecosystem. These terms, due to their significance and recognition, should always be capitalized to maintain consistency and clarity. I propose compiling a list of such proper nouns to be included in our documentation guidelines for contributors. This list will serve as a reference for maintaining standard capitalization practices in our documents. Additionally, updating our Vale configuration to reflect these guidelines will help in automatically ensuring adherence to these standards in our documentation.
Implementation Ideas
Initial list (to be increased):
The text was updated successfully, but these errors were encountered: