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.

Sign up for GitHub

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

Jump to bottom

fix(Style guide): Modified the preview callout title #17826

Merged
merged 7 commits into from
Jul 16, 2024
Merged

fix(Style guide): Modified the preview callout title #17826

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
07fc3a9
fix(Style guide): Modified the preview callout title
nbaenam Jun 28, 2024
e4a4ebb
Merge branch 'develop' into nb-style-guide-callout-preview
nbaenam Jun 28, 2024
3654656
fix(styleguide): Added boilerplate from legal
rhetoric101 Jul 2, 2024
e48b318
fix(styleguide): Clarify language.
rhetoric101 Jul 2, 2024
99ffe15
style(style guide): Break preview doc guidance out
austin-schaefer Jul 9, 2024
23dfaea
fix(Preview callout): Added TW comments
nbaenam Jul 15, 2024
7e147c3
fix(Style guide): Added TW comments
nbaenam Jul 16, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 4 additions & 2 deletions src/content/docs/alerts/incident-management/postmortems-applied-intelligence.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,8 +20,10 @@ import accountsPostmortem6 from 'images/accounts_screenshot-crop_postmortem-6.we

import accountsPostmortemEdit from 'images/accounts_screenshot-full_postmortem-edit.webp'

<Callout title="Public preview">
This feature is still in development, but we encourage you to try it out.
<Callout title="preview">
We're still working on this feature, but we'd love for you to try it out!
nbaenam marked this conversation as resolved.
Show resolved Hide resolved

This feature is currently provided as part of a preview program pursuant to our [pre-release policies](/docs/licenses/license-information/referenced-policies/new-relic-pre-release-policy).
</Callout>

With alerts' postmortems feature, events, metrics, and metadata are automatically collected to create a template you can use to run an incident postmortem for your team.
Expand Down
6 changes: 4 additions & 2 deletions ...frastructure/host-integrations/host-integrations-list/atlassian-integration.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,8 +21,10 @@ import opentelemetryJiraNRConfiguration from 'images/opentelemetry_screenshot-fu

New Relic offers an integration with Atlassian Jira that syncs your New Relic issue and incident information with Jira. This data then appears in Jira in the [incidents feature](https://support.atlassian.com/jira-software-cloud/docs/what-is-the-incidents-feature/) and lets you connect it with Jira issues to improve your outage workflows. The sections cover how to set up this integration and best practices for using it.

<Callout title="PREVIEW FEATURE">
This feature is still in preview, but we encourage you to try it out!
<Callout title="preview">
We're still working on this feature, but we'd love for you to try it out!
nbaenam marked this conversation as resolved.
Show resolved Hide resolved

This feature is currently provided as part of a preview program pursuant to our [pre-release policies](/docs/licenses/license-information/referenced-policies/new-relic-pre-release-policy).
</Callout>


Expand Down
7 changes: 5 additions & 2 deletions ...cture/host-integrations/host-integrations-list/ibmmq-monitoring-integration.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,8 +17,11 @@ import OsLinux from 'images/os_icon_linux.webp'

import OsWindows from 'images/os_icon_windows.webp'

<Callout title="Public preview">
This feature is currently a public preview.

<Callout title="preview">
We're still working on this feature, but we'd love for you to try it out!
nbaenam marked this conversation as resolved.
Show resolved Hide resolved

This feature is currently provided as part of a preview program pursuant to our [pre-release policies](/docs/licenses/license-information/referenced-policies/new-relic-pre-release-policy).
</Callout>

Our IBM MQ [integration](/docs/integrations/host-integrations/getting-started/introduction-host-integrations)
Expand Down
8 changes: 6 additions & 2 deletions ...re/host-integrations/host-integrations-list/powerdns-monitoring-integration.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,8 +11,12 @@ redirects:
freshnessValidatedDate: never
---

<Callout title="PUBLIC PREVIEW">
This feature is currently in public preview and only applies to the versions starting on [0.0.5](https://github.com/newrelic/newrelic-prometheus-exporters-packages/releases/tag/nri-powerdns-0.0.5) released in October 2021.
<Callout title="preview">
We're still working on this feature, but we'd love for you to try it out!

It only applies to the versions starting on [0.0.5](https://github.com/newrelic/newrelic-prometheus-exporters-packages/releases/tag/nri-powerdns-0.0.5) released in October 2021.
nbaenam marked this conversation as resolved.
Show resolved Hide resolved

This feature is currently provided as part of a preview program pursuant to our [pre-release policies](/docs/licenses/license-information/referenced-policies/new-relic-pre-release-policy).
</Callout>

Our PowerDNS [integration](/docs/integrations/host-integrations/getting-started/introduction-host-integrations)
Expand Down
9 changes: 6 additions & 3 deletions src/content/docs/instrumentation-editor-instrument-net-ui.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,10 +9,13 @@ freshnessValidatedDate: never

import apmDotnetInstrumentationEditor from 'images/apm_screenshot-full_dotnet-instrumentation-editor.webp'

<Callout title="PREVIEW FEATURE">
This feature is currently in preview.
<Callout title="preview">
We're still working on this feature, but we'd love for you to try it out!

If you have questions or feedback, or if you need help during the preview of the .NET agent's <DNT>**Instrumentation**</DNT> editor, send an email to [[email protected]](mailto:[email protected]).
nbaenam marked this conversation as resolved.
Show resolved Hide resolved

This feature is currently provided as part of a preview program pursuant to our [pre-release policies](/docs/licenses/license-information/referenced-policies/new-relic-pre-release-policy).

If you have questions or feedback, or if you need help during the preview of the .NET agent's <DNT>**Instrumentation**</DNT> editor, send an email to [[email protected]](mailto:[email protected]).
</Callout>

Our <DNT>**Instrumentation**</DNT> editor allows .NET app users to implement custom instrumentation from the New Relic user interface without requiring a restart of the instrumented application. This editor:
Expand Down
6 changes: 4 additions & 2 deletions src/content/docs/kubernetes-pixie/kubecost/get-started-kubecost.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,8 +10,10 @@ metaDescription: "Understand the costs associated with your Kubernetes resources
freshnessValidatedDate: 2023-08-12
---

<Callout title="Preview">
This feature is currently in preview.
<Callout title="preview">
We're still working on this feature, but we'd love for you to try it out!
nbaenam marked this conversation as resolved.
Show resolved Hide resolved

This feature is currently provided as part of a preview program pursuant to our [pre-release policies](/docs/licenses/license-information/referenced-policies/new-relic-pre-release-policy).
</Callout>

With New Relic and [Kubecost](https://kubecost.github.io/cost-analyzer/), you can understand the costs associated with each of your Kubernetes resources.
Expand Down
7 changes: 5 additions & 2 deletions ...ixie/kubernetes-integration/advanced-configuration/newrelic-metrics-adapter.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,8 +12,11 @@ freshnessValidatedDate: never

import kubernetesAdapterDiagram from 'images/kubernetes_diagram_adapter-diagram.svg'

<Callout title="PUBLIC PREVIEW">
This feature is still in public preview, but we encourage you to try it out!

<Callout title="preview">
We're still working on this feature, but we'd love for you to try it out!
nbaenam marked this conversation as resolved.
Show resolved Hide resolved

This feature is currently provided as part of a preview program pursuant to our [pre-release policies](/docs/licenses/license-information/referenced-policies/new-relic-pre-release-policy).
</Callout>

You can use metrics from your New Relic account to autoscale applications and services in your Kubernetes cluster by deploying the [New Relic Metrics Adapter](https://github.com/newrelic/newrelic-k8s-metrics-adapter). This adapter fetches the metric values from New Relic and makes them available for the [Horizontal Pod Autoscalers](https://kubernetes.io/docs/tasks/run-application/horizontal-pod-autoscale/).
Expand Down
4 changes: 3 additions & 1 deletion ...ocs/kubernetes-pixie/kubernetes-integration/installation/k8s-agent-operator.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,8 @@ freshnessValidatedDate: 2024-06-28

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

This feature is currently provided as part of a preview program pursuant to our [pre-release policies](/docs/licenses/license-information/referenced-policies/new-relic-pre-release-policy).
</Callout>

The Kubernetes agent operator streamlines full-stack observability for Kubernetes environments by automating APM instrumentation alongside Kubernetes agent deployment. By enabling APM auto instrumentation, developers no longer need to manually manage [APM agents](/docs/apm/new-relic-apm/getting-started/introduction-apm/). The Kubernetes agent operator will automatically installs, upgrades, and removes APM agents.
Expand Down Expand Up @@ -249,7 +251,7 @@ To uninstall and delete the Kubernetes agent operator, run this command:
>
Yes, you just need to change your [license key](/docs/apis/intro-apis/new-relic-api-keys/#license-key) injected in the secret in the appropriate namespace.

<Callout title="PUBLIC PREVIEW">
<Callout variant="important">
The [K8s APM experience](/docs/apm/apm-ui-pages/monitoring/kubernetes-summary-page/) is only available on the account where the data from the applications and the K8s cluster is available.
</Callout>
</Collapser>
Expand Down
7 changes: 5 additions & 2 deletions ...kubernetes-pixie/kubernetes-integration/installation/kubernetes-eks-fargate.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,8 +17,11 @@ import kubernetesFargateWorkflow from 'images/kubernetes_diagram_fargate-workflo

import kubernetesFargateUi from 'images/kubernetes_screenshot-crop_fargate-ui.webp'

<Callout title="Preview">
This feature is currently in preview.

<Callout title="preview">
We're still working on this feature, but we'd love for you to try it out!
nbaenam marked this conversation as resolved.
Show resolved Hide resolved

This feature is currently provided as part of a preview program pursuant to our [pre-release policies](/docs/licenses/license-information/referenced-policies/new-relic-pre-release-policy).
</Callout>


Expand Down
6 changes: 4 additions & 2 deletions ...ocs/kubernetes-pixie/kubernetes-integration/installation/kubernetes-windows.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,8 +9,10 @@ metaDescription: "New Relic's Kubernetes integration: The installation of Kubern
freshnessValidatedDate: 2024-04-29
---

<Callout title="Preview">
This feature is currently in preview.
<Callout title="preview">
We're still working on this feature, but we'd love for you to try it out!
nbaenam marked this conversation as resolved.
Show resolved Hide resolved

This feature is currently provided as part of a preview program pursuant to our [pre-release policies](/docs/licenses/license-information/referenced-policies/new-relic-pre-release-policy).
</Callout>

Use this option when you've a Windows-based Kubernetes system. Note that Windows integration has several [limitations](#k8-windows-limitations).
Expand Down
7 changes: 5 additions & 2 deletions src/content/docs/nrql/using-nrql/query-infrastructure-dimensional-metrics-nrql.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,8 +12,11 @@ freshnessValidatedDate: 2024-03-19

import queriesnrqlDimensionalMetricsNamingConvention from 'images/queries-nrql_diagram_dimensional-metrics-naming-convention.webp'

<Callout title="PREVIEW FEATURE">
This feature is currently in preview.

<Callout title="preview">
We're still working on this feature, but we'd love for you to try it out!
nbaenam marked this conversation as resolved.
Show resolved Hide resolved

This feature is currently provided as part of a preview program pursuant to our [pre-release policies](/docs/licenses/license-information/referenced-policies/new-relic-pre-release-policy).
</Callout>

[Dimensional metrics](/docs/using-new-relic/data/understand-data/new-relic-data-types#dimensional-metrics) are an industry standard for storing and querying metric data. New Relic stores all infrastructure metrics [as event data](/docs/data-apis/understand-data/new-relic-data-types/#metric-event-attributes), but you can also query them as dimensional metrics.
Expand Down
34 changes: 29 additions & 5 deletions src/content/docs/style-guide/structure/callouts.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -83,11 +83,6 @@ Here are examples of our callout variants:
</Callout>
```

For preview docs, add a custom callout. Also, we recommend that you don't include a variant so you display the default color:

<Callout title="PREVIEW FEATURE">
This feature is still in development, but we encourage you to try it out!
</Callout>
</Collapser>
</CollapserGroup>

Expand Down Expand Up @@ -117,3 +112,32 @@ Here's an example of the stacked callouts we'd love to avoid.
<Callout variant="caution">
Think carefully before adding another callout on the page.
</Callout>

## Preview doc callouts [#preview-callouts]

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

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

For the content inside the callout, you can use whatever text you want for the first line, but for the remainder of the callout, you need to include some boilerplate language.

* **For public previews on `docs.newrelic.com`**: You must also include this standard message in the callout at the top of each preview page.

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

This feature is currently provided as part of a preview program pursuant to our [pre-release policies](/docs/licenses/license-information/referenced-policies/new-relic-pre-release-policy).
</Callout>

* **For preview features only available on our private beta site**: You must also include this standard message in the callout at the top of each preview page.

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

New Relic's proprietary and confidential information. For authorized users only. Unauthorized uses and disclosures are prohibited.

This feature is currently provided as part of a preview program pursuant to our [pre-release policies](/docs/licenses/license-information/referenced-policies/new-relic-pre-release-policy).
</Callout>

14 changes: 7 additions & 7 deletions src/content/docs/style-guide/word-choice/usage-dictionary.mdx
View file
Open in desktop
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 FEATURE">
This feature is currently in preview.
<Callout title="preview">
We're still working on this feature, but we'd love for you to try it out!
nbaenam marked this conversation as resolved.
Show resolved Hide resolved
</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
6 changes: 4 additions & 2 deletions src/install/ibm-mq/intro.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,10 @@ componentType: default

import infrastructureIbmmqDashboard from 'images/infrastructure_screenshot-crop_ibmmq-dashboard.webp'

<Callout title="Public preview">
This feature is currently a public preview.
<Callout title="preview">
We're still working on this feature, but we'd love for you to try it out!
nbaenam marked this conversation as resolved.
Show resolved Hide resolved

This feature is currently provided as part of a preview program pursuant to our [pre-release policies](/docs/licenses/license-information/referenced-policies/new-relic-pre-release-policy).
</Callout>

Our IBM MQ [integration](/docs/integrations/host-integrations/getting-started/introduction-host-integrations)
Expand Down
Loading