Skip to content

Commit

Permalink
fix(Style guide): Added TW comments
Browse files Browse the repository at this point in the history
  • Loading branch information
nbaenam committed Jul 16, 2024
1 parent 23dfaea commit 7e147c3
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 6 deletions.
2 changes: 1 addition & 1 deletion src/content/docs/style-guide/structure/callouts.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -113,7 +113,7 @@ Here's an example of the stacked callouts we'd love to avoid.
Think carefully before adding another callout on the page.
</Callout>

## Preview doc callouts
## Preview doc callouts [#preview-callouts]

For preview docs, add a custom callout using the default color:

Expand Down
10 changes: 5 additions & 5 deletions src/content/docs/style-guide/word-choice/usage-dictionary.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -694,13 +694,13 @@ E words are words that use `e` as a shorthand for electronic, like ebook, ecomme
id="new-preview"
title="New or preview usage"
>
Use *New* to refer to a feature or capability that has recently been released to the general public (GA). In the UI, use the [badge component](https://one-core.newrelic.com/components/badge/) to label new features or capabilities.
Use `New` to refer to a feature or capability that has recently been released to the general public (GA). In the UI, use the [badge component](https://one-core.newrelic.com/components/badge/) to label new features or capabilities.

Use *Preview* to refer to features and capabilities that are pre-GA but are available to select users and sometimes more broadly. These features or capabilities are usually not complete. Previews enable us to gather initial user feedback as we work towards general availability.
Use `Preview` to refer to features and capabilities that are pre-GA but are available to select users and sometimes more broadly. These features or capabilities are usually not complete. Previews enable us to gather initial user feedback as we work towards general availability.

For either term, in the UI, use the [badge component](https://one-core.newrelic.com/components/badge/) in spots like these:
- the left-hand navigation
- the tile on the All Capabilities page
- the tile on the <DNT>**All Capabilities**</DNT> page
- the page title
</Collapser>

Expand Down Expand Up @@ -926,13 +926,13 @@ For more information about observability, see [Product and cabilities: observabi
id="Preview"
title="preview"
>
Docs use the [preview callout](/docs/style-guide/quick-reference/callouts/) for features in [preview](#new-preview). In the body text, use lowercase. For example:
Docs use the [preview callout](/docs/style-guide/structure/callouts/#preview-callouts) for features in [preview](#new-preview). In the body text, use lowercase. For example:

<Callout title="preview">
We're still working on this feature, but we'd love for you to try it out!
</Callout>

If the developer team prefers to use a term other than preview, clarify what is driving that use of the term (Legal requirement?), and add any relevant info here in the usage dictionary.
In addition to your preview invitation, you should add legal boilerplate language as outlined in our [style guide](/docs/style-guide/structure/callouts/#preview-callouts).
</Collapser>

<Collapser
Expand Down

0 comments on commit 7e147c3

Please sign in to comment.