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

Standardize capitalization of key proper nouns in Quarkus documentation #37868

Open
rolfedh opened this issue Dec 20, 2023 · 4 comments
Open
Assignees
Labels

Comments

@rolfedh
Copy link
Contributor

rolfedh commented Dec 20, 2023

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):

  • Jakarta Persistence
  • Quarkus Security
@gsmet
Copy link
Member

gsmet commented Dec 20, 2023

Hey @rolfedh ,

Do you have examples in mind?

Also, I think we need to discuss this as a community before including things in guidelines.

@quarkus-bot
Copy link

quarkus-bot bot commented Dec 21, 2023

/cc @ebullient (documentation), @inoxx03 (documentation), @michelle-purcell (documentation), @sunayna15 (documentation)

@rolfedh
Copy link
Contributor Author

rolfedh commented Jan 2, 2024

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.
In the meantime, here are some raw uncurated results from a script whose pattern matches multi-word proper nouns, such as "New York City", "Mother-in-Law", or "REST":

[rdlugyhe@rdlugyhe-thinkpadt14sgen2i main]$ python /home/rdlugyhe/pythontools/find-proper-nouns.py --min_count 15
Cloud Event: 67
Cloud Function: 23
Configuration Reference: 37
Confluent Schema Registry: 15
Context SecurityContext: 22
Dev Service: 236
Funqy HTTP: 15
Getting Started: 23
Google Cloud: 37
Google Cloud Function: 38
Hello World: 15
Hibernate ORM: 172
Hibernate Reactive: 87
Hibernate Search: 40
Jakarta Persistence: 58
Jakarta REST: 215
Kafka Stream: 25
Maven Project: 19
MicroProfile Config: 15
Microsoft SQL Server: 18
Observes StartupEvent: 24
Property Expression: 19
Quarkus Maven: 32
Quarkus Security: 79
REST Client: 66
REST Client Reactive: 23
REST Datum: 19
RESTEasy Classic: 18
RESTEasy Reactive: 154
Reactive Messaging: 48
Reactive Route: 15
SmallRye Config: 18
SmallRye JWT: 21
SmallRye Reactive Messaging: 46
Spring Security: 16
Spring Web: 25
X GET: 27
X POST: 19

Please let me know if you have any questions or suggestions. I appreciate your help and collaboration. 😊

@rolfedh
Copy link
Contributor Author

rolfedh commented Jan 4, 2024

To managage and discuss the full list of terms, let's use the "Upstream terms for discussion" tab of the Quarkus Terminology spreadsheet.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
Development

No branches or pull requests

5 participants