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

Add Enterprise product acronyms #381

Closed
wants to merge 1 commit into from
Closed

Conversation

osg-grafana
Copy link
Contributor

GEL stands for Grafana Enterprise Logs
GEM stands for Grafana Enterprise Metrics
GET stands for Grafana Enterprise Traces

GEL stands for Grafana Enterprise Logs
GEM stands for Grafana Enterprise Metrics
GET stands for Grafana Enterprise Traces
@osg-grafana osg-grafana self-assigned this Nov 13, 2023
@osg-grafana osg-grafana added the type/docs Docs Squad label used across all Grafana Labs repos label Nov 13, 2023
Copy link
Member

@jdbaldry jdbaldry left a comment

Choose a reason for hiding this comment

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

Are we at the stage where we shouldn't first introduce GEM as Grafana Enterprise Metrics (GEM)?

@osg-grafana
Copy link
Contributor Author

osg-grafana commented Nov 13, 2023

Are we at the stage where we shouldn't first introduce GEM as Grafana Enterprise Metrics (GEM)?

Do you mean first instance of GEM on a page, or in every instance that it is used?

If it is already defined on a page, there is no need to define it again. From, "Spell out '%s', if it is unfamiliar to the audience.", the reader will know what GEM is after it has already been defined on a page. In that case, subsequent usages need not be continually defined or spelled out.

@jdbaldry
Copy link
Member

I believe this rule only fires if the acronym hasn't already been spelled out.

That is, it will not warn in:

The product is Grafana Enterprise Metrics (GEM).

GEM is the product.

but it will fire for:

The product is Grafana Enterprise Metrics.

GEM is the product.

@osg-grafana
Copy link
Contributor Author

osg-grafana commented Nov 14, 2023

Closing PR because we need to warn on any usage that does not have this initially spelled out at the page level.

@osg-grafana osg-grafana deleted the osg-grafana-patch-2 branch November 14, 2023 12:03
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
type/docs Docs Squad label used across all Grafana Labs repos
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants