Skip to content

Commit

Permalink
chore: Normalize usage of Nerdpack
Browse files Browse the repository at this point in the history
  • Loading branch information
alexronquillo committed Apr 30, 2021
1 parent 138dfb2 commit e53aeb6
Show file tree
Hide file tree
Showing 6 changed files with 46 additions and 46 deletions.
2 changes: 1 addition & 1 deletion src/data/nav.yml
Original file line number Diff line number Diff line change
Expand Up @@ -59,7 +59,7 @@
url: '/build-apps/publish-deploy/serve'
- title: Publish your Nerdpack
url: '/build-apps/publish-deploy/publish'
- title: Subscribe to your app or visualization
- title: Subscribe to your Nerdpack
url: '/build-apps/publish-deploy/subscribe'
- title: Update your Nerdpack's catalog information
url: '/build-apps/publish-deploy/catalog'
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ Add screenshots, descriptions, and other metadata to your Nerdpack, and upload i

## Check your permissions

To publish your app or visualization and update its catalog information, you need:
To publish your Nerdpack and update its catalog information, you need:

- Access to the account that published it
- The [necessary permissions for managing Nerdpacks](/build-apps/permission-manage-apps)
Expand Down Expand Up @@ -84,7 +84,7 @@ Navigate to **Apps**:

Find your published Nerdpack under **New Relic One catalog**:

![Published app or visualization](../../../images/serve-publish-subscribe/published-app.png)
![Published Nerdpack](../../../images/serve-publish-subscribe/published-app.png)

Notice that there is no information on the **Apps** or details page other than the Nerdpack's name and the brief description found in _nr1.json_:

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ Publish your Nerdpack, whether it's still in development, ready for testing, or

## Check your permissions

When you publish your Nerdpack, it's registered with the New Relic One catalog. From there, some users can subscribe to your app or visualization. Subscribing users need to have:
When you publish your Nerdpack, it's registered with the New Relic One catalog. From there, some users can subscribe to your Nerdpack. Subscribing users need to have:

- Access to the account that published the Nerdpack
- The [necessary permissions for managing Nerdpacks](/build-apps/permission-manage-apps)
Expand Down Expand Up @@ -159,15 +159,15 @@ Whether you published a New Relic One application or a custom visualization, you

<Step>

Find your published app or visualization under **New Relic One catalog**:
Find your published Nerdpack under **New Relic One catalog**:

![Published app or visualization](../../../images/serve-publish-subscribe/published-app.png)
![Published Nerdpack](../../../images/serve-publish-subscribe/published-app.png)

Notice the `Custom` indicator on its UI tile. Use this to distinguish between published Nerdpacks and locally-served Nerdpacks.

<Callout variant="tip">

Only apps and visualizations with tagged versions are shown under **New Relic One catalog**. So, if you published without a tag or removed a tag from your published app or visualization, you won't see it in the catalog.
Only Nerdpacks with tagged versions are shown under **New Relic One catalog**. So, if you published without a tag or removed a tag from your published Nerdpack, you won't see it in the catalog.

</Callout>

Expand Down Expand Up @@ -204,7 +204,7 @@ nr1 nerdpack:publish --verbose

## Reveal your published Nerdpack information

If you don't find your app or visualization in New Relic, it may not be tagged. Remember, at least one version of your published Nerdpack must have a tag for it to show on the **Apps** page. See more information about your published Nerdpack with `nr1 nerdpack:info`:
If you don't find your Nerdpack in New Relic, it may not be tagged. Remember, at least one version of your published Nerdpack must have a tag for it to show on the **Apps** page. See more information about your published Nerdpack with `nr1 nerdpack:info`:

```sh
nr1 nerdpack:info
Expand All @@ -226,7 +226,7 @@ In this example, there is one published version, but it isn't tagged. You can ta
nr1 nerdpack:tag --from-version=1.0.0 --tag=DEV
```

Now, if you refresh your browser page, you should see your app or visualization on **Apps**.
Now, if you refresh your browser page, you should see your Nerdpack on **Apps**.

<Callout variant="tip">

Expand All @@ -238,4 +238,4 @@ Read our [`nr1 nerdpack:tag`](/explore-docs/nr1-nerdpack#nr1-nerdpacktag) docume

With `nr1`, you can [set a default New Relic profile](/explore-docs/nr1-common#nr1-profiles). This profile is used for all commands unless otherwise specified with the command's `--profile` option. When you publish your Nerdpack, only users who can access your account can see your published Nerdpack.

So, if you don't find your app or visualization in New Relic but you know it's published, compare your local profile with the profile you're using in the browser to make sure they're the same.
So, if you don't find your Nerdpack in New Relic but you know it's published, compare your local profile with the profile you're using in the browser to make sure they're the same.
10 changes: 5 additions & 5 deletions src/markdown-pages/build-apps/serve-publish-subscribe/serve.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ tags:

<Intro>

Serve your Nerdpack locally when it's still in development and you're not ready to share it with others. You'll use your own machine's resources, but you'll see the app or visualization in the New Relic platform as you would if it were published.
Serve your Nerdpack locally when it's still in development and you're not ready to share it with others. You'll use your own machine's resources, but you'll see the Nerdpack in the New Relic platform as you would if it were published.

</Intro>

Expand All @@ -41,7 +41,7 @@ If you've successfully served your Nerdpack, you should see some success output,
[output] {blue}↩{normal} Server will reload automatically if you modify any file!
```
While your Nerdpack is being served locally, the server will automatically reload your app or visualization when it detects that you've modified a file. This doesn't include the metadata file _nr1.json_ or the styles file _styles.css_. If you update those files, you need to stop your local server with `CTRL+C` and restart it with `nr1 nerdpack:serve`.
While your Nerdpack is being served locally, the server will automatically reload your Nerdpack when it detects that you've modified a file. This doesn't include the metadata file _nr1.json_ or the styles file _styles.css_. If you update those files, you need to stop your local server with `CTRL+C` and restart it with `nr1 nerdpack:serve`.
</Step>
Expand Down Expand Up @@ -118,13 +118,13 @@ nr1 nerdpack:serve --verbose
### Show locally served Nerdpacks
If you don't find your app or visualization in New Relic, make sure you're using the `?nerdpacks=local` query string. If you're not, New Relic won't load your locally served Nerdpack on the platform.
If you don't find your Nerdpack in New Relic, make sure you're using the `?nerdpacks=local` query string. If you're not, New Relic won't load your locally served Nerdpack on the platform.
### Check your local profile
With `nr1`, you can [set a default New Relic profile](/explore-docs/nr1-common#nr1-profiles). This profile is used for all commands unless otherwise specified with the command's `--profile` option. When you serve your Nerdpack with `nr1 nerdpack:serve`, you must be signed into the same profile in New Relic that you're serving with locally.
So, if you don't find your app or visualization in New Relic and you're using the correct query string, compare your local profile with the profile you're using in the browser to make sure they're the same.
So, if you don't find your Nerdpack in New Relic and you're using the correct query string, compare your local profile with the profile you're using in the browser to make sure they're the same.
### Access your proxy browser
Expand All @@ -134,7 +134,7 @@ When you run `nr1 nerdpack:serve`, your code is served by your local machine usi
To load a Nerdpack into the platform, whether it's locally served or published to the app catalog, New Relic uses an `<IFRAME>` and a separate domain (a subdomain of nr-ext.net), relying on same-domain policy to sandbox the code.
So, if you don't find your app or visualization in New Relic, you're using the correct query string, and you're using the correct profile, your network administrator may need to enable access to:
So, if you don't find your Nerdpack in New Relic, you're using the correct query string, and you're using the correct profile, your network administrator may need to enable access to:
- Any subdomain of nr-local.net, or, at the very least, to any domain of the shape of `<UserId>`.nr-local.net, where `<UserId>` is a 32-hexadecimal character identifier that is unique to the user logged into the platform. You can use `[0-9a-f]{32}` to discriminate it.
- Any subdomain of nr-ext.net, or, at the very least, to any domain in the shape of `<NerdpackUuid>`.g `<NerdpackGid>`.nr-ext.net, where `<NerdpackUuid>` is the UUID assigned to your package, and `<NerdpackGid>` is zero, or a positive integer. You can use `0|[1-9]\d+` to discriminate it.
Expand Down
52 changes: 26 additions & 26 deletions src/markdown-pages/build-apps/serve-publish-subscribe/subscribe.mdx
Original file line number Diff line number Diff line change
@@ -1,25 +1,25 @@
---
path: '/build-apps/publish-deploy/subscribe'
title: 'Subscribe to an app or visualization'
title: 'Subscribe to a Nerdpack'
template: 'GuideTemplate'
description: 'Learn to subscribe to an app or visualization'
description: 'Learn to subscribe to a Nerdpack'
tileShorthand:
title: 'Subscribe to an app or visualization'
description: 'Subscribe to an app or visualization'
title: 'Subscribe to a Nerdpack'
description: 'Subscribe to a Nerdpack'
tags:
- nerdpack
- subscribe
---

<Intro>

Subscribe to an app or visualization to use it in the New Relic platform. Unsubscribe from apps and visualizations you no longer use.
Subscribe to a Nerdpack to use it in the New Relic platform. Unsubscribe from Nerdpacks you no longer use.

</Intro>

## Check your permissions

To subscribe to an app or visualization, you need:
To subscribe to a Nerdpack, you need:

- Access to the account that published it
- The [necessary permissions for managing Nerdpacks](/build-apps/permission-manage-apps)
Expand All @@ -31,13 +31,13 @@ You need to publish Nerdpacks that you create before you can subscribe to them:
1. [Publish your Nerdpack](/build-apps/publish-deploy/publish)
2. [Tag your Nerdpack](/build-apps/publish-deploy/tag) if it's published and doesn't yet have a tag

## Subscribe to an app or visualization
## Subscribe to a Nerdpack

Subscribe to a published app or visualization, with either the web UI or the `nr1` CLI, to use it in your account. Subscribing allows you to select the tagged version you want to use as well as the account you want to subscribe with. This lets you control what apps and visualizations you use in your account.
Subscribe to a published Nerdpack, with either the web UI or the `nr1` CLI, to use it in your account. Subscribing allows you to select the tagged version you want to use as well as the account you want to subscribe with. This lets you control what Nerdpacks you use in your account.

<Callout variant="tip">

When the tag you've subscribed to gets an update, New Relic updates your app or visualization automatically.
When the tag you've subscribed to gets an update, New Relic updates your Nerdpack automatically.

</Callout>

Expand All @@ -61,21 +61,21 @@ Navigate to **Apps**:

<Step>

Find your published app or visualization under **New Relic One catalog**:
Find your published Nerdpack under **New Relic One catalog**:

![Published app or visualization](../../../images/serve-publish-subscribe/published-app.png)
![Published Nerdpack](../../../images/serve-publish-subscribe/published-app.png)

All published apps and visualizations are shown in the New Relic One catalog. However, the one you're looking for maybe filtered out. Adjust the filter to find the app or visualization you're looking for:
All published Nerdpacks are shown in the New Relic One catalog. However, the one you're looking for maybe filtered out. Adjust the filter to find the Nerdpack you're looking for:

![Filter the catalog](../../../images/build-an-app/catalog-filter.png)

</Step>

<Step>

Select the app or visualization you want to add to your New Relic account:
Select the Nerdpack you want to add to your New Relic account:

![Select an app or visualization](../../../images/serve-publish-subscribe/select-account-maturity-app.png)
![Select a Nerdpack](../../../images/serve-publish-subscribe/select-account-maturity-app.png)

</Step>

Expand All @@ -85,23 +85,23 @@ Click **Add this app**:

![Select Add this app](../../../images/serve-publish-subscribe/add-this-account-maturity-app.png)

This button says **Manage access** if you're already subscribed to the app or visualization.
This button says **Manage access** if you're already subscribed to the Nerdpack.

</Step>

<Step>

Select the account to subscribe with and the tagged version to subscribe to. Then, update your account(s):

![Subscribe to the app or visualization](../../../images/serve-publish-subscribe/subscribe-to-account-maturity-app.png)
![Subscribe to the Nerdpack](../../../images/serve-publish-subscribe/subscribe-to-account-maturity-app.png)

<Callout variant="tip">

In the web UI, and some places in the CLI, we refer to **tags** as **channels**. This is a relic of a past implementation of Nerdpack versioning. Ignoring historical and implementation details, consider them to be synonyms.

</Callout>

Now you, and members of the accounts you've subscribed with, can launch the app or visualization from New Relic.
Now you, and members of the accounts you've subscribed with, can launch the Nerdpack from New Relic.

</Step>

Expand All @@ -121,7 +121,7 @@ If you subscribed to a visualization, find it under **Custom visualizations**:

## Subscribe from the command line

If you've published your own Nerdpack, it may be quicker to subscribe to your app or visualization with the `nr1` CLI.
If you've published your own Nerdpack, it may be quicker to subscribe to your Nerdpack with the `nr1` CLI.

<Steps>

Expand Down Expand Up @@ -188,9 +188,9 @@ nr1 subscription:set --help

</Steps>

## Unsubscribe from an app or visualization
## Unsubscribe from a Nerdpack

Unsubscribe from an app or visualization to remove it from your account.
Unsubscribe from a Nerdpack to remove it from your account.

<Steps>

Expand All @@ -212,7 +212,7 @@ Navigate to **Apps**:

<Step>

Click the "i" icon next to the app or visualization you're subscribed to:
Click the "i" icon next to the Nerdpack you're subscribed to:

![Navigate to the Apps page](../../../images/build-an-app/click-info-icon.png)

Expand Down Expand Up @@ -240,7 +240,7 @@ Deselect the accounts you want to unsubscribe with. Then, update those accounts:

## Unsubscribe using the command line

Quickly unsubscribe your CLI profile from apps or visualizations.
Quickly unsubscribe your CLI profile from Nerdpacks.

<Steps>

Expand Down Expand Up @@ -270,7 +270,7 @@ nr1 subscription:list

<Step>

Unsubscribe from the app or visualization with the UUID:
Unsubscribe from the Nerdpack with the UUID:

```sh
nr1 nerdpack:unsubscribe --nerdpack-id=384de6e5-8e57-4d56-9d13-299ee7ae8641
Expand All @@ -295,11 +295,11 @@ nr1 subscription:unset --help

## Resolve issues with accessing your published Nerdpack

Sometimes, when you subscribe to an app or visualization, you may come across issues. Whether you can't subscribe or see duplicate subscriptions in your account, consider some common solutions for resolving these issues.
Sometimes, when you subscribe to a Nerdpack, you may run into issues. Whether you can't subscribe or see duplicate subscriptions in your account, consider some common solutions for resolving these issues.

### Tag your app or visualization
### Tag your Nerdpack version

When you subscribe to an app or visualization, you choose a specific tag. So, if the app or visualization you're trying to subscribe to isn't tagged, or doesn't have the tag you're targeting, [tag](/build-apps/publish-deploy/tag) your release version:
When you subscribe to an Nerdpack, you choose a specific tag. So, if the Nerdpack you're trying to subscribe to isn't tagged, or doesn't have the tag you're targeting, [tag](/build-apps/publish-deploy/tag) your release version:

```sh
nr1 nerdpack:subscribe --channel=DEV
Expand Down
10 changes: 5 additions & 5 deletions src/markdown-pages/build-apps/serve-publish-subscribe/tag.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ tags:

<Intro>

Tag your Nerdpack versions to track and subscribe to them. Untag versions to prevent subscriptions or hide apps and visualizations from the catalog.
Tag your Nerdpack versions to track and subscribe to them. Untag versions to prevent subscriptions or hide Nerdpacks from the catalog.

</Intro>

Expand Down Expand Up @@ -47,12 +47,12 @@ Here, you tagged version `1.0.0` as `DEV`.

Now, you, and other users on your account, can use this tag:

- You see the tag as an option to subscribe to when you add the app or visualization to your account
- You see the tag as an option to subscribe to when you add the Nerdpack to your account
- If you subscribe to the `DEV` tag and it gets updated later—say, `DEV` is applied to version `1.0.1`—you automatically get upgraded to the new version without having to subscribe again.

<Callout variant="important">

One of the features of tagging release versions is that users who are subscribed to a tag automatically get updates when that tag is used for another version. This means that if a user is testing one version, say `1.0.0`, and you apply that same tag to another version, say `1.0.1`, that user will see version `1.0.1` in their account, and they can no longer access the app or visualization they were testing before. Often times, this is the expected behavior, but make sure you consider this side effect when you use tags.
One of the features of tagging release versions is that users who are subscribed to a tag automatically get updates when that tag is used for another version. This means that if a user is testing one version, say `1.0.0`, and you apply that same tag to another version, say `1.0.1`, that user will see version `1.0.1` in their account, and they can no longer access the Nerdpack they were testing before. Often times, this is the expected behavior, but make sure you consider this side effect when you use tags.

</Callout>

Expand Down Expand Up @@ -211,7 +211,7 @@ nr1 nerdpack:publish --tag=DEV
</Callout>
### Unsubscribe from the app or visualization
### Unsubscribe from the Nerdpack
You can only remove tags that have no subscribers. If you try to remove a tag that users are subscribed to, you'll get an error:
Expand All @@ -234,7 +234,7 @@ nr1 nerdpack:untag -t DEV
[output] {error}›{normal} Error: A downstream error occurred.
```
In this case, check to see if you're subscribed to the app or visualization:
In this case, check to see if you're subscribed to the Nerdpack:
```sh
nr1 subscription:list
Expand Down

0 comments on commit e53aeb6

Please sign in to comment.