search

micronaut-projects / micronaut-core

Micronaut Application Framework
http://micronaut.io
Apache License 2.0
6.04k stars 1.06k forks source link

Docs: Clean up usage of "Micronaut" in user guide #7573

Open JasonTypesCodes opened 2 years ago

JasonTypesCodes commented 2 years ago

Issue description

Micronaut should not be used as a noun. There are multiple instances of this in the core user guide. For example:

Micronaut is a modern, JVM-based, full stack Java framework designed for building modular, easily testable JVM applications with support for Java, Kotlin, and Groovy.

Micronaut is developed by the creators of the Grails framework and takes inspiration from lessons learnt over the years building real-world applications from monoliths to microservices using Spring, Spring Boot and Grails.

Micronaut aims to provide all the tools necessary to build JVM applications including:

alvarosanchez commented 2 years ago

How should it be used then? And more importantly: why?

osscontributor commented 2 years ago

How should it be used then?

@alvarosanchez It is a good question.

The Trademark Policy linked from https://micronaut.io/brand-guidelines/ provides guidance, and calls out some info like the following to help:

- The word Micronaut in paragraph text should always be printed with the “M” capitalized and the remainder of the name in lowercase. In headings, the word may be printed in all caps.
- The first use of the word “Micronaut” in running text should always be followed by the registered trademark symbol (®).
- You may not use the word Micronaut as a verb or a noun. It should be used only as an adjective followed by a noun (e.g., “I love using the Micronaut® framework,” not “I love using Micronaut!”).
- You may not use the word Micronaut in the plural or possessive form.