From 07fc3a91f6d300974392a8617f90a044b36e912f Mon Sep 17 00:00:00 2001 From: nbaenam Date: Fri, 28 Jun 2024 14:48:36 +0200 Subject: [PATCH 1/6] fix(Style guide): Modified the preview callout title --- .../postmortems-applied-intelligence.mdx | 4 ++-- .../host-integrations-list/atlassian-integration.mdx | 4 ++-- .../ibmmq-monitoring-integration.mdx | 5 +++-- .../powerdns-monitoring-integration.mdx | 6 ++++-- .../docs/instrumentation-editor-instrument-net-ui.mdx | 6 +++--- .../kubernetes-pixie/kubecost/get-started-kubecost.mdx | 4 ++-- .../advanced-configuration/newrelic-metrics-adapter.mdx | 5 +++-- .../installation/kubernetes-eks-fargate.mdx | 5 +++-- .../installation/kubernetes-windows.mdx | 4 ++-- .../query-infrastructure-dimensional-metrics-nrql.mdx | 5 +++-- src/content/docs/style-guide/structure/callouts.mdx | 7 ++++--- .../docs/style-guide/word-choice/usage-dictionary.mdx | 4 ++-- src/install/ibm-mq/intro.mdx | 4 ++-- 13 files changed, 35 insertions(+), 28 deletions(-) diff --git a/src/content/docs/alerts/incident-management/postmortems-applied-intelligence.mdx b/src/content/docs/alerts/incident-management/postmortems-applied-intelligence.mdx index bbc55bfab5b..63093bb8d18 100644 --- a/src/content/docs/alerts/incident-management/postmortems-applied-intelligence.mdx +++ b/src/content/docs/alerts/incident-management/postmortems-applied-intelligence.mdx @@ -20,8 +20,8 @@ import accountsPostmortem6 from 'images/accounts_screenshot-crop_postmortem-6.we import accountsPostmortemEdit from 'images/accounts_screenshot-full_postmortem-edit.webp' - -This feature is still in development, but we encourage you to try it out. + + We're still working on this feature, but we'd love for you to try it out! 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. diff --git a/src/content/docs/infrastructure/host-integrations/host-integrations-list/atlassian-integration.mdx b/src/content/docs/infrastructure/host-integrations/host-integrations-list/atlassian-integration.mdx index 185a25bd4af..8f4d6ff6aa1 100644 --- a/src/content/docs/infrastructure/host-integrations/host-integrations-list/atlassian-integration.mdx +++ b/src/content/docs/infrastructure/host-integrations/host-integrations-list/atlassian-integration.mdx @@ -21,8 +21,8 @@ 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. - - This feature is still in preview, but we encourage you to try it out! + + We're still working on this feature, but we'd love for you to try it out! diff --git a/src/content/docs/infrastructure/host-integrations/host-integrations-list/ibmmq-monitoring-integration.mdx b/src/content/docs/infrastructure/host-integrations/host-integrations-list/ibmmq-monitoring-integration.mdx index aa448d26b37..a6632200cf8 100644 --- a/src/content/docs/infrastructure/host-integrations/host-integrations-list/ibmmq-monitoring-integration.mdx +++ b/src/content/docs/infrastructure/host-integrations/host-integrations-list/ibmmq-monitoring-integration.mdx @@ -17,8 +17,9 @@ import OsLinux from 'images/os_icon_linux.webp' import OsWindows from 'images/os_icon_windows.webp' - - This feature is currently a public preview. + + + We're still working on this feature, but we'd love for you to try it out! Our IBM MQ [integration](/docs/integrations/host-integrations/getting-started/introduction-host-integrations) diff --git a/src/content/docs/infrastructure/host-integrations/host-integrations-list/powerdns-monitoring-integration.mdx b/src/content/docs/infrastructure/host-integrations/host-integrations-list/powerdns-monitoring-integration.mdx index ef4863e91e1..eb756382610 100644 --- a/src/content/docs/infrastructure/host-integrations/host-integrations-list/powerdns-monitoring-integration.mdx +++ b/src/content/docs/infrastructure/host-integrations/host-integrations-list/powerdns-monitoring-integration.mdx @@ -11,8 +11,10 @@ redirects: freshnessValidatedDate: never --- - - 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. + + 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. Our PowerDNS [integration](/docs/integrations/host-integrations/getting-started/introduction-host-integrations) diff --git a/src/content/docs/instrumentation-editor-instrument-net-ui.mdx b/src/content/docs/instrumentation-editor-instrument-net-ui.mdx index 0a3e8b66dec..4b2954fcf0a 100644 --- a/src/content/docs/instrumentation-editor-instrument-net-ui.mdx +++ b/src/content/docs/instrumentation-editor-instrument-net-ui.mdx @@ -9,10 +9,10 @@ freshnessValidatedDate: never import apmDotnetInstrumentationEditor from 'images/apm_screenshot-full_dotnet-instrumentation-editor.webp' - - This feature is currently in 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 **Instrumentation** editor, send an email to [dotnet-li-editor-beta@newrelic.com](mailto:dotnet-li-editor-beta@newrelic.com). +If you have questions or feedback, or if you need help during the preview of the .NET agent's **Instrumentation** editor, send an email to [dotnet-li-editor-beta@newrelic.com](mailto:dotnet-li-editor-beta@newrelic.com). Our **Instrumentation** 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: diff --git a/src/content/docs/kubernetes-pixie/kubecost/get-started-kubecost.mdx b/src/content/docs/kubernetes-pixie/kubecost/get-started-kubecost.mdx index 8099ad4a79f..5e6dd47bca8 100644 --- a/src/content/docs/kubernetes-pixie/kubecost/get-started-kubecost.mdx +++ b/src/content/docs/kubernetes-pixie/kubecost/get-started-kubecost.mdx @@ -10,8 +10,8 @@ metaDescription: "Understand the costs associated with your Kubernetes resources freshnessValidatedDate: 2023-08-12 --- - - This feature is currently in preview. + + We're still working on this feature, but we'd love for you to try it out! With New Relic and [Kubecost](https://kubecost.github.io/cost-analyzer/), you can understand the costs associated with each of your Kubernetes resources. diff --git a/src/content/docs/kubernetes-pixie/kubernetes-integration/advanced-configuration/newrelic-metrics-adapter.mdx b/src/content/docs/kubernetes-pixie/kubernetes-integration/advanced-configuration/newrelic-metrics-adapter.mdx index 77f42577f9f..bd69f35226e 100644 --- a/src/content/docs/kubernetes-pixie/kubernetes-integration/advanced-configuration/newrelic-metrics-adapter.mdx +++ b/src/content/docs/kubernetes-pixie/kubernetes-integration/advanced-configuration/newrelic-metrics-adapter.mdx @@ -12,8 +12,9 @@ freshnessValidatedDate: never import kubernetesAdapterDiagram from 'images/kubernetes_diagram_adapter-diagram.svg' - - This feature is still in public preview, but we encourage you to try it out! + + + We're still working on this feature, but we'd love for you to try it out! 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/). diff --git a/src/content/docs/kubernetes-pixie/kubernetes-integration/installation/kubernetes-eks-fargate.mdx b/src/content/docs/kubernetes-pixie/kubernetes-integration/installation/kubernetes-eks-fargate.mdx index 84bf41f2357..d380dbd40af 100644 --- a/src/content/docs/kubernetes-pixie/kubernetes-integration/installation/kubernetes-eks-fargate.mdx +++ b/src/content/docs/kubernetes-pixie/kubernetes-integration/installation/kubernetes-eks-fargate.mdx @@ -17,8 +17,9 @@ import kubernetesFargateWorkflow from 'images/kubernetes_diagram_fargate-workflo import kubernetesFargateUi from 'images/kubernetes_screenshot-crop_fargate-ui.webp' - -This feature is currently in preview. + + + We're still working on this feature, but we'd love for you to try it out! diff --git a/src/content/docs/kubernetes-pixie/kubernetes-integration/installation/kubernetes-windows.mdx b/src/content/docs/kubernetes-pixie/kubernetes-integration/installation/kubernetes-windows.mdx index 5795ee12220..e08c613c939 100644 --- a/src/content/docs/kubernetes-pixie/kubernetes-integration/installation/kubernetes-windows.mdx +++ b/src/content/docs/kubernetes-pixie/kubernetes-integration/installation/kubernetes-windows.mdx @@ -9,8 +9,8 @@ metaDescription: "New Relic's Kubernetes integration: The installation of Kubern freshnessValidatedDate: 2024-04-29 --- - -This feature is currently in preview. + + We're still working on this feature, but we'd love for you to try it out! Use this option when you've a Windows-based Kubernetes system. Note that Windows integration has several [limitations](#k8-windows-limitations). diff --git a/src/content/docs/nrql/using-nrql/query-infrastructure-dimensional-metrics-nrql.mdx b/src/content/docs/nrql/using-nrql/query-infrastructure-dimensional-metrics-nrql.mdx index 3f3978a6a46..65cd6383ac4 100644 --- a/src/content/docs/nrql/using-nrql/query-infrastructure-dimensional-metrics-nrql.mdx +++ b/src/content/docs/nrql/using-nrql/query-infrastructure-dimensional-metrics-nrql.mdx @@ -12,8 +12,9 @@ freshnessValidatedDate: 2024-03-19 import queriesnrqlDimensionalMetricsNamingConvention from 'images/queries-nrql_diagram_dimensional-metrics-naming-convention.webp' - - This feature is currently in preview. + + + We're still working on this feature, but we'd love for you to try it out! [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. diff --git a/src/content/docs/style-guide/structure/callouts.mdx b/src/content/docs/style-guide/structure/callouts.mdx index 82b9795b3c2..a66b8fba5ca 100644 --- a/src/content/docs/style-guide/structure/callouts.mdx +++ b/src/content/docs/style-guide/structure/callouts.mdx @@ -85,9 +85,10 @@ Here are examples of our callout variants: For preview docs, add a custom callout. Also, we recommend that you don't include a variant so you display the default color: - - This feature is still in development, but we encourage you to try it out! - + + We're still working on this feature, but we'd love for you to try it out! + + diff --git a/src/content/docs/style-guide/word-choice/usage-dictionary.mdx b/src/content/docs/style-guide/word-choice/usage-dictionary.mdx index 7e396b195f3..8634f22903a 100644 --- a/src/content/docs/style-guide/word-choice/usage-dictionary.mdx +++ b/src/content/docs/style-guide/word-choice/usage-dictionary.mdx @@ -928,8 +928,8 @@ For more information about observability, see [Product and cabilities: observabi > 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: - - This feature is currently in preview. + + We're still working on this feature, but we'd love for you to try it out! 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. diff --git a/src/install/ibm-mq/intro.mdx b/src/install/ibm-mq/intro.mdx index c5aa87f8bba..bf32dc0988f 100644 --- a/src/install/ibm-mq/intro.mdx +++ b/src/install/ibm-mq/intro.mdx @@ -5,8 +5,8 @@ componentType: default import infrastructureIbmmqDashboard from 'images/infrastructure_screenshot-crop_ibmmq-dashboard.webp' - - This feature is currently a public preview. + + We're still working on this feature, but we'd love for you to try it out! Our IBM MQ [integration](/docs/integrations/host-integrations/getting-started/introduction-host-integrations) From 3654656b0d579cadc121bdd5aa0b5343603b198f Mon Sep 17 00:00:00 2001 From: Rob Siebens Date: Tue, 2 Jul 2024 14:24:15 -0700 Subject: [PATCH 2/6] fix(styleguide): Added boilerplate from legal --- .../docs/style-guide/structure/callouts.mdx | 17 ++++++++++++++++- 1 file changed, 16 insertions(+), 1 deletion(-) diff --git a/src/content/docs/style-guide/structure/callouts.mdx b/src/content/docs/style-guide/structure/callouts.mdx index a66b8fba5ca..3ca3bff9b7b 100644 --- a/src/content/docs/style-guide/structure/callouts.mdx +++ b/src/content/docs/style-guide/structure/callouts.mdx @@ -83,12 +83,27 @@ Here are examples of our callout variants: ``` + Here are some additional considerations for preview docs: + For preview docs, add a custom callout. Also, we recommend that you don't include a variant so you display the default color: We're still working on this feature, but we'd love for you to try it out! - + + For the content inside the callout, you can use whatever text you want for the first line, but these are the requirements for the remainder of the callout: + + * **For public previews on `docs.newrelic.com`**: You must also include this standard message in the callout at the top of each preview page. + ``` + 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). + ``` + * **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. + ``` + 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). + ``` + From e48b3187cacb05d6e6deb0f21368fd35af69386d Mon Sep 17 00:00:00 2001 From: Rob Siebens Date: Tue, 2 Jul 2024 15:57:09 -0700 Subject: [PATCH 3/6] fix(styleguide): Clarify language. --- src/content/docs/style-guide/structure/callouts.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/content/docs/style-guide/structure/callouts.mdx b/src/content/docs/style-guide/structure/callouts.mdx index 3ca3bff9b7b..26324db5627 100644 --- a/src/content/docs/style-guide/structure/callouts.mdx +++ b/src/content/docs/style-guide/structure/callouts.mdx @@ -91,7 +91,7 @@ Here are examples of our callout variants: We're still working on this feature, but we'd love for you to try it out! - For the content inside the callout, you can use whatever text you want for the first line, but these are the requirements for the remainder of the 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. ``` From 99ffe15b3656db3d9f9f1d74d55e87a1675de675 Mon Sep 17 00:00:00 2001 From: Austin Schaefer <55203603+austin-schaefer@users.noreply.github.com> Date: Tue, 9 Jul 2024 10:49:49 -0700 Subject: [PATCH 4/6] style(style guide): Break preview doc guidance out --- .../docs/style-guide/structure/callouts.mdx | 42 +++++++++---------- 1 file changed, 21 insertions(+), 21 deletions(-) diff --git a/src/content/docs/style-guide/structure/callouts.mdx b/src/content/docs/style-guide/structure/callouts.mdx index 26324db5627..ff7c6e82a4f 100644 --- a/src/content/docs/style-guide/structure/callouts.mdx +++ b/src/content/docs/style-guide/structure/callouts.mdx @@ -83,27 +83,6 @@ Here are examples of our callout variants: ``` - Here are some additional considerations for preview docs: - - For preview docs, add a custom callout. Also, we recommend that you don't include a variant so you display the default color: - - - We're still working on this feature, but we'd love for you to try it out! - - - 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. - ``` - 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). - ``` - * **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. - ``` - 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). - ``` - @@ -133,3 +112,24 @@ Here's an example of the stacked callouts we'd love to avoid. Think carefully before adding another callout on the page. + +## Preview doc callouts + +For preview docs, add a custom callout using the default color: + + + We're still working on this feature, but we'd love for you to try it out! + + +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. + ``` + 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). + ``` +* **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. + ``` + 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). + ``` From 23dfaea1c40c47ebd74c940379d8249413570127 Mon Sep 17 00:00:00 2001 From: nbaenam Date: Mon, 15 Jul 2024 11:31:54 +0200 Subject: [PATCH 5/6] fix(Preview callout): Added TW comments --- .../postmortems-applied-intelligence.mdx | 2 ++ .../atlassian-integration.mdx | 2 ++ .../ibmmq-monitoring-integration.mdx | 2 ++ .../powerdns-monitoring-integration.mdx | 2 ++ ...strumentation-editor-instrument-net-ui.mdx | 4 ++- .../kubecost/get-started-kubecost.mdx | 2 ++ .../newrelic-metrics-adapter.mdx | 2 ++ .../installation/k8s-agent-operator.mdx | 4 ++- .../installation/kubernetes-eks-fargate.mdx | 2 ++ .../installation/kubernetes-windows.mdx | 2 ++ ...nfrastructure-dimensional-metrics-nrql.mdx | 2 ++ .../docs/style-guide/structure/callouts.mdx | 28 ++++++++++++------- src/install/ibm-mq/intro.mdx | 2 ++ 13 files changed, 44 insertions(+), 12 deletions(-) diff --git a/src/content/docs/alerts/incident-management/postmortems-applied-intelligence.mdx b/src/content/docs/alerts/incident-management/postmortems-applied-intelligence.mdx index 8a34ecec506..074d6c288e9 100644 --- a/src/content/docs/alerts/incident-management/postmortems-applied-intelligence.mdx +++ b/src/content/docs/alerts/incident-management/postmortems-applied-intelligence.mdx @@ -22,6 +22,8 @@ import accountsPostmortemEdit from 'images/accounts_screenshot-full_postmortem-e 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). 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. diff --git a/src/content/docs/infrastructure/host-integrations/host-integrations-list/atlassian-integration.mdx b/src/content/docs/infrastructure/host-integrations/host-integrations-list/atlassian-integration.mdx index a7b21be9ce1..1197782a786 100644 --- a/src/content/docs/infrastructure/host-integrations/host-integrations-list/atlassian-integration.mdx +++ b/src/content/docs/infrastructure/host-integrations/host-integrations-list/atlassian-integration.mdx @@ -23,6 +23,8 @@ New Relic offers an integration with Atlassian Jira that syncs your New Relic is 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). diff --git a/src/content/docs/infrastructure/host-integrations/host-integrations-list/ibmmq-monitoring-integration.mdx b/src/content/docs/infrastructure/host-integrations/host-integrations-list/ibmmq-monitoring-integration.mdx index 30d064aa209..ed6632a0cbd 100644 --- a/src/content/docs/infrastructure/host-integrations/host-integrations-list/ibmmq-monitoring-integration.mdx +++ b/src/content/docs/infrastructure/host-integrations/host-integrations-list/ibmmq-monitoring-integration.mdx @@ -20,6 +20,8 @@ import OsWindows from 'images/os_icon_windows.webp' 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). Our IBM MQ [integration](/docs/integrations/host-integrations/getting-started/introduction-host-integrations) diff --git a/src/content/docs/infrastructure/host-integrations/host-integrations-list/powerdns-monitoring-integration.mdx b/src/content/docs/infrastructure/host-integrations/host-integrations-list/powerdns-monitoring-integration.mdx index 02995cac34a..c2e3879eaa7 100644 --- a/src/content/docs/infrastructure/host-integrations/host-integrations-list/powerdns-monitoring-integration.mdx +++ b/src/content/docs/infrastructure/host-integrations/host-integrations-list/powerdns-monitoring-integration.mdx @@ -15,6 +15,8 @@ freshnessValidatedDate: never 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. + + 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). Our PowerDNS [integration](/docs/integrations/host-integrations/getting-started/introduction-host-integrations) diff --git a/src/content/docs/instrumentation-editor-instrument-net-ui.mdx b/src/content/docs/instrumentation-editor-instrument-net-ui.mdx index 099f6aa68b8..6ca49a5cc75 100644 --- a/src/content/docs/instrumentation-editor-instrument-net-ui.mdx +++ b/src/content/docs/instrumentation-editor-instrument-net-ui.mdx @@ -9,10 +9,12 @@ freshnessValidatedDate: never import apmDotnetInstrumentationEditor from 'images/apm_screenshot-full_dotnet-instrumentation-editor.webp' - + 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 **Instrumentation** editor, send an email to [dotnet-li-editor-beta@newrelic.com](mailto:dotnet-li-editor-beta@newrelic.com). + +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). diff --git a/src/content/docs/kubernetes-pixie/kubecost/get-started-kubecost.mdx b/src/content/docs/kubernetes-pixie/kubecost/get-started-kubecost.mdx index 10df4324b92..1652f5c0772 100644 --- a/src/content/docs/kubernetes-pixie/kubecost/get-started-kubecost.mdx +++ b/src/content/docs/kubernetes-pixie/kubecost/get-started-kubecost.mdx @@ -12,6 +12,8 @@ freshnessValidatedDate: 2023-08-12 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). With New Relic and [Kubecost](https://kubecost.github.io/cost-analyzer/), you can understand the costs associated with each of your Kubernetes resources. diff --git a/src/content/docs/kubernetes-pixie/kubernetes-integration/advanced-configuration/newrelic-metrics-adapter.mdx b/src/content/docs/kubernetes-pixie/kubernetes-integration/advanced-configuration/newrelic-metrics-adapter.mdx index bd69f35226e..0ac95248342 100644 --- a/src/content/docs/kubernetes-pixie/kubernetes-integration/advanced-configuration/newrelic-metrics-adapter.mdx +++ b/src/content/docs/kubernetes-pixie/kubernetes-integration/advanced-configuration/newrelic-metrics-adapter.mdx @@ -15,6 +15,8 @@ import kubernetesAdapterDiagram from 'images/kubernetes_diagram_adapter-diagram. 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). 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/). diff --git a/src/content/docs/kubernetes-pixie/kubernetes-integration/installation/k8s-agent-operator.mdx b/src/content/docs/kubernetes-pixie/kubernetes-integration/installation/k8s-agent-operator.mdx index 0405db1cbed..7bdbb19366b 100644 --- a/src/content/docs/kubernetes-pixie/kubernetes-integration/installation/k8s-agent-operator.mdx +++ b/src/content/docs/kubernetes-pixie/kubernetes-integration/installation/k8s-agent-operator.mdx @@ -11,6 +11,8 @@ freshnessValidatedDate: 2024-06-28 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). 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. @@ -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. - + 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. diff --git a/src/content/docs/kubernetes-pixie/kubernetes-integration/installation/kubernetes-eks-fargate.mdx b/src/content/docs/kubernetes-pixie/kubernetes-integration/installation/kubernetes-eks-fargate.mdx index daf5eebce54..5bb2a93d68d 100644 --- a/src/content/docs/kubernetes-pixie/kubernetes-integration/installation/kubernetes-eks-fargate.mdx +++ b/src/content/docs/kubernetes-pixie/kubernetes-integration/installation/kubernetes-eks-fargate.mdx @@ -20,6 +20,8 @@ import kubernetesFargateUi from 'images/kubernetes_screenshot-crop_fargate-ui.we 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). diff --git a/src/content/docs/kubernetes-pixie/kubernetes-integration/installation/kubernetes-windows.mdx b/src/content/docs/kubernetes-pixie/kubernetes-integration/installation/kubernetes-windows.mdx index e08c613c939..b0eb6d6cb66 100644 --- a/src/content/docs/kubernetes-pixie/kubernetes-integration/installation/kubernetes-windows.mdx +++ b/src/content/docs/kubernetes-pixie/kubernetes-integration/installation/kubernetes-windows.mdx @@ -11,6 +11,8 @@ freshnessValidatedDate: 2024-04-29 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). Use this option when you've a Windows-based Kubernetes system. Note that Windows integration has several [limitations](#k8-windows-limitations). diff --git a/src/content/docs/nrql/using-nrql/query-infrastructure-dimensional-metrics-nrql.mdx b/src/content/docs/nrql/using-nrql/query-infrastructure-dimensional-metrics-nrql.mdx index 5e7558cf5c3..9acb5e9d47e 100644 --- a/src/content/docs/nrql/using-nrql/query-infrastructure-dimensional-metrics-nrql.mdx +++ b/src/content/docs/nrql/using-nrql/query-infrastructure-dimensional-metrics-nrql.mdx @@ -15,6 +15,8 @@ import queriesnrqlDimensionalMetricsNamingConvention from 'images/queries-nrql_d 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). [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. diff --git a/src/content/docs/style-guide/structure/callouts.mdx b/src/content/docs/style-guide/structure/callouts.mdx index ff7c6e82a4f..01f1ceda278 100644 --- a/src/content/docs/style-guide/structure/callouts.mdx +++ b/src/content/docs/style-guide/structure/callouts.mdx @@ -117,19 +117,27 @@ Here's an example of the stacked callouts we'd love to avoid. For preview docs, add a custom callout using the default color: - - We're still working on this feature, but we'd love for you to try it out! - + + We're still working on this feature, but we'd love for you to try it out! + 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. - ``` - 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). - ``` + + + 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). + + * **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. - ``` - 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). - ``` + + 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). + + diff --git a/src/install/ibm-mq/intro.mdx b/src/install/ibm-mq/intro.mdx index bf32dc0988f..ce642fcab91 100644 --- a/src/install/ibm-mq/intro.mdx +++ b/src/install/ibm-mq/intro.mdx @@ -7,6 +7,8 @@ import infrastructureIbmmqDashboard from 'images/infrastructure_screenshot-crop_ 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). Our IBM MQ [integration](/docs/integrations/host-integrations/getting-started/introduction-host-integrations) From 7e147c31045edc8687c23b38498e812ed4477ab0 Mon Sep 17 00:00:00 2001 From: nbaenam Date: Tue, 16 Jul 2024 11:29:43 +0200 Subject: [PATCH 6/6] fix(Style guide): Added TW comments --- src/content/docs/style-guide/structure/callouts.mdx | 2 +- .../docs/style-guide/word-choice/usage-dictionary.mdx | 10 +++++----- 2 files changed, 6 insertions(+), 6 deletions(-) diff --git a/src/content/docs/style-guide/structure/callouts.mdx b/src/content/docs/style-guide/structure/callouts.mdx index 01f1ceda278..81dbb15ecaf 100644 --- a/src/content/docs/style-guide/structure/callouts.mdx +++ b/src/content/docs/style-guide/structure/callouts.mdx @@ -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. -## Preview doc callouts +## Preview doc callouts [#preview-callouts] For preview docs, add a custom callout using the default color: diff --git a/src/content/docs/style-guide/word-choice/usage-dictionary.mdx b/src/content/docs/style-guide/word-choice/usage-dictionary.mdx index 8634f22903a..42f8fee1699 100644 --- a/src/content/docs/style-guide/word-choice/usage-dictionary.mdx +++ b/src/content/docs/style-guide/word-choice/usage-dictionary.mdx @@ -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 **All Capabilities** page - the page title @@ -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: We're still working on this feature, but we'd love for you to try it out! - 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).