From 20b3297ee1dd5278d0b46f322fc1f7dcdddba75f Mon Sep 17 00:00:00 2001 From: Jerel Miller Date: Fri, 23 Oct 2020 15:07:59 -0700 Subject: [PATCH] fix: update guides to use the component --- .../automate-workflows/5-mins-tag-resources.mdx | 4 ++-- .../automate-workflows/automated-tagging.mdx | 8 ++++---- .../automate-workflows/get-started-terraform.mdx | 12 ++++++------ .../build-apps/build-hello-world-app.mdx | 4 ++-- src/markdown-pages/build-apps/publish-deploy.mdx | 4 ++-- src/markdown-pages/build-apps/set-up-dev-env.mdx | 6 +++--- .../get-started-nerdgraph-api-explorer.mdx | 4 ++-- src/markdown-pages/explore-docs/nerdstoragevault.mdx | 8 ++++---- src/markdown-pages/explore-docs/nr1-cli.mdx | 4 ++-- 9 files changed, 27 insertions(+), 27 deletions(-) diff --git a/src/markdown-pages/automate-workflows/5-mins-tag-resources.mdx b/src/markdown-pages/automate-workflows/5-mins-tag-resources.mdx index 0dd28fb4f..6b3f57ef1 100644 --- a/src/markdown-pages/automate-workflows/5-mins-tag-resources.mdx +++ b/src/markdown-pages/automate-workflows/5-mins-tag-resources.mdx @@ -133,11 +133,11 @@ To make sure that the tags have been added to your entities, retrieve them using `newrelic entity tags get --guid GUID` - + Tags can be deleted at any time by invoking the [`entity tags delete`](https://github.com/newrelic/newrelic-cli/blob/master/docs/cli/newrelic_entity_tags_delete.md) command followed by the same arguments you used to create them. - + ```json lineNumbers=false [ diff --git a/src/markdown-pages/automate-workflows/automated-tagging.mdx b/src/markdown-pages/automate-workflows/automated-tagging.mdx index 341246bb8..6f5b59e61 100644 --- a/src/markdown-pages/automate-workflows/automated-tagging.mdx +++ b/src/markdown-pages/automate-workflows/automated-tagging.mdx @@ -40,11 +40,11 @@ Throughout this guide, you use three open source projects to automatically set u Each project is distinct, and encapsulates its own behavior. This maintains a separation of concerns and allows you to compose complex scenarios using a modular approach. - + The Demo Deployer is currently in development. Because of our commitment to open source, we are working in the open early in the process and invite you to collaborate with us. Drop any thoughts and comments in the [Build on New Relic](https://discuss.newrelic.com/c/build-on-new-relic) support thread, and let us know what you think! - + The last thing you need before you get started is to install [Docker](https://docs.docker.com/get-docker/) if you don't have it already. @@ -128,11 +128,11 @@ Finally, you pass a list of arguments to the entrypoint, including: - `-c configs/creds.json`: The user credentials configuration file - `-d documentation/tutorial/user_stories/Hello/hello.json`: The [deployment configuration file](https://github.com/newrelic/demo-deployer/tree/main/documentation/deploy_config) - + You can specify the log level for the deployer using `-l`. `info` is the default, but you can also use `debug` or `error`. This is a helpful option to use when something goes wrong. - + Once you run this command, the deployer will create and instrument some specific resources. This may take a few minutes. In the meantime, read on to learn more about what is actually happening during this process. diff --git a/src/markdown-pages/automate-workflows/get-started-terraform.mdx b/src/markdown-pages/automate-workflows/get-started-terraform.mdx index 00c019bcd..192134471 100644 --- a/src/markdown-pages/automate-workflows/get-started-terraform.mdx +++ b/src/markdown-pages/automate-workflows/get-started-terraform.mdx @@ -102,13 +102,13 @@ provider "newrelic" { By setting these values on the New Relic provider, you're configuring that provider to make changes on behalf of your account through New Relic APIs. - + You can also configure the New Relic provider using [environment variables](https://registry.terraform.io/providers/newrelic/newrelic/latest/docs/guides/provider_configuration). This is a useful way to set default values for your provider configuration. For more information about configuring the New Relic provider, please feel free to check out our official provider [documentation](https://registry.terraform.io/providers/newrelic/newrelic/latest/docs/guides/provider_configuration). - + With your New Relic provider configured, initialize Terraform: @@ -355,7 +355,7 @@ A `newrelic_alert_policy_channel` links the notification channel you just create To finalize your golden signal alerts configuration, run `terraform apply` one last time to make sure all of your configured resources are up to date. - + `new_relic_alert_channel` [supports several types](https://registry.terraform.io/providers/newrelic/newrelic/latest/docs/resources/alert_channel#argument-reference) of notification channels, including: email, slack, and pagerduty. So, if you want to explore this more, try creating an alert channel for a second channel type, such as Slack: @@ -375,7 +375,7 @@ resource "newrelic_alert_channel" "slack_notification" { Before you `apply` this change, you need to add the [New Relic Slack App](https://slack.com/apps/A0F827KK2-new-relic-alerts) to your Slack account and select a Slack channel to send the notification. With this new alert channel, triggered alerts send notifications to the Slack channel of your choice. - + @@ -385,10 +385,10 @@ Before you `apply` this change, you need to add the [New Relic Slack App](https: As your team evaluates the alerting system you’ve put in place, you’ll find that you may need to tweak configuration values, such as the alert threshold and duration. If you manage your Terraform project in a remote repository, you can submit a pull request so your team can review these changes alongside the rest of your code contributions. - + You may also want to consider automating this process in your CI/CD pipeline. Use Terraform's [recommended practices guide](https://www.terraform.io/docs/cloud/guides/recommended-practices/index.html) to learn more about their recommended workflow and how to evolve your provisioning practices. - + Congratulations! You're officially practicing observability-as-code. Review the [New Relic Terraform provider documentation](https://registry.terraform.io/providers/newrelic/newrelic/latest/docs) to learn how you can take your configuration to the next level. diff --git a/src/markdown-pages/build-apps/build-hello-world-app.mdx b/src/markdown-pages/build-apps/build-hello-world-app.mdx index 761ee3511..ffe96f7d6 100644 --- a/src/markdown-pages/build-apps/build-hello-world-app.mdx +++ b/src/markdown-pages/build-apps/build-hello-world-app.mdx @@ -41,11 +41,11 @@ If you haven't already installed it, do the following: For additional details about setting up your environment, see [Set up your development environment](set-up-dev-env). - + Use the [NR1 VS Code extension](https://marketplace.visualstudio.com/items?itemName=new-relic.nr1) to build your apps. - + ## Create a local version of the "Hello, World!" application diff --git a/src/markdown-pages/build-apps/publish-deploy.mdx b/src/markdown-pages/build-apps/publish-deploy.mdx index e9b167f0d..076776ac1 100644 --- a/src/markdown-pages/build-apps/publish-deploy.mdx +++ b/src/markdown-pages/build-apps/publish-deploy.mdx @@ -178,11 +178,11 @@ Publishing places your Nerdpack in New Relic One. To publish or deploy, you must New Relic One requires that only one version (following semantic versioning) of a Nerdpack can be published at a time. - + If you know what channel you want to deploy to (as described in the Deploy your app section that follows), you can run `nr1 nerdpack:publish --channel=STABLE` or `nr1 nerdpack:publish --channel=BETA`. - + diff --git a/src/markdown-pages/build-apps/set-up-dev-env.mdx b/src/markdown-pages/build-apps/set-up-dev-env.mdx index b149d0931..ec58bc4fb 100644 --- a/src/markdown-pages/build-apps/set-up-dev-env.mdx +++ b/src/markdown-pages/build-apps/set-up-dev-env.mdx @@ -29,7 +29,6 @@ Depending on what you want to do with your app, you might have some additional s - Downloading the New Relic One CLI to build or modify apps - Contribute content to this website - ## Before you begin You must have: @@ -39,15 +38,16 @@ You must have: - [npm](https://www.npmjs.com/get-npm) - If you've installed [Node.js](https://nodejs.org/en/download/), then you already have `npm`, which is used to share, reuse, and update JavaScript code, and is necessary for working with React components that are the framework for New Relic apps and this website. ### A note on support + Building a New Relic One application is the same as building any JavaScript/React application. We offer support to help with our building tools ([our CLI](/explore-docs/nr1-cli) and [SDK library](/explore-docs/intro-to-sdk)). However, we don't offer support for basic JavaScript or React coding questions or issues. For common questions and answers about building, see the [Explorers Hub page on building on New Relic One](https://discuss.newrelic.com/c/build-on-new-relic). - + Use the [New Relic One VSCode extension](https://marketplace.visualstudio.com/items?itemName=new-relic.nr1) to build your apps. - + ## Prepare to build or modify apps diff --git a/src/markdown-pages/collect-data/get-started-nerdgraph-api-explorer.mdx b/src/markdown-pages/collect-data/get-started-nerdgraph-api-explorer.mdx index 301c66609..da33b507c 100644 --- a/src/markdown-pages/collect-data/get-started-nerdgraph-api-explorer.mdx +++ b/src/markdown-pages/collect-data/get-started-nerdgraph-api-explorer.mdx @@ -107,11 +107,11 @@ Ready for your first mutation? In this case, you're trying to add a custom tag to an entity. Notice that the editor complains if you don't select `errors`: mutations must have a way of telling you how the operation performed in the backend (failed requests result in null responses). - + Unlike REST, GraphQL APIs like NerdGraph can return partial responses. For example, if you try adding tags to multiple entities, some mutations can fail and others succeed; all is logged in the GraphQL response you get. - + diff --git a/src/markdown-pages/explore-docs/nerdstoragevault.mdx b/src/markdown-pages/explore-docs/nerdstoragevault.mdx index ce905e1d4..c4722b4af 100644 --- a/src/markdown-pages/explore-docs/nerdstoragevault.mdx +++ b/src/markdown-pages/explore-docs/nerdstoragevault.mdx @@ -38,11 +38,11 @@ NerdStorageVault is used to store and retrieve sensitive secrets data such as: - API keys - other third party secrets - + NerdStorageVault is encrypted with AES-256 encryption - + ## Usage considerations @@ -62,9 +62,9 @@ Nr1 core components for additional functionality. Below are examples of the queries used by the components to interact with NerdStorageVault. - + NerdStorageVault can currently only be used within the context of a Nerdpack. - + ### Write diff --git a/src/markdown-pages/explore-docs/nr1-cli.mdx b/src/markdown-pages/explore-docs/nr1-cli.mdx index dbfc93cd4..4c4b1897f 100644 --- a/src/markdown-pages/explore-docs/nr1-cli.mdx +++ b/src/markdown-pages/explore-docs/nr1-cli.mdx @@ -46,11 +46,11 @@ In New Relic, click **Apps** and then in the **New Relic One catalog** area, cli
- + Use the [NR1 VS Code extension](https://marketplace.visualstudio.com/items?itemName=new-relic.nr1) to build your apps. - + ## New Relic One CLI Commands