Skip to content

Commit

Permalink
Merge pull request #1709 from newrelic/mlosier/io-packdetails-refresh
Browse files Browse the repository at this point in the history
Mlosier/io packdetails refresh
  • Loading branch information
alexronquillo authored Sep 29, 2021
2 parents c1254ba + c34d318 commit f949138
Show file tree
Hide file tree
Showing 45 changed files with 302 additions and 307 deletions.
Binary file modified src/images/ab-test/add-this-app.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified src/images/ab-test/app-about.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified src/images/ab-test/app-details-from-launcher.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified src/images/ab-test/app-in-catalog.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified src/images/ab-test/app-meta-in-catalog.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified src/images/ab-test/dev-version.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified src/images/ab-test/manage-access.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified src/images/ab-test/select-launcher.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified src/images/ab-test/your-apps.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified src/images/build-an-app/add-victory-charts.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified src/images/build-an-app/apps_catalog.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified src/images/build-an-app/click-info-icon.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified src/images/build-an-app/entity-nerdlet.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added src/images/build-an-app/io-filter.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified src/images/build-an-app/nav-to-apps.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified src/images/build-an-app/nav-to-custom-viz.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified src/images/build-an-app/victory-charts-nerdpack.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified src/images/build-an-app/victory-charts-repo.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified src/images/create-hello-world/catalog-description-empty.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified src/images/serve-publish-subscribe/custom-viz.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified src/images/serve-publish-subscribe/demo-app-details-icon.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified src/images/serve-publish-subscribe/demo-app-details.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified src/images/serve-publish-subscribe/demo-app-launcher-icon.png
Binary file modified src/images/serve-publish-subscribe/demo-app-no-details.png
Binary file modified src/images/serve-publish-subscribe/demo-app-tagline.png
Binary file modified src/images/serve-publish-subscribe/home.png
Binary file modified src/images/serve-publish-subscribe/local-app.png
Binary file modified src/images/serve-publish-subscribe/nav-to-apps.png
Binary file added src/images/serve-publish-subscribe/nav-to-io.png
Binary file modified src/images/serve-publish-subscribe/published-app.png
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ Each lesson in the course builds upon the last, so make sure you've completed th

<Intro>

In the previous lesson, you added a configuration option to your visualization that allows you to choose how you want to represent your data. This was different from the previous version of your code because, while you can still choose your chart type, you can now only do it before you create an instance of your visualization. But what does it mean to create an instance of your visualization? How do you use a visualization once you've configured it?
In the previous lesson, you added a configuration option to your visualization that allows you to choose how you want to represent your data. This was different from the previous version of your code because, while you can still choose your chart type, you can now only do it before you create an instance of your visualization. But what does it mean to create an instance of your visualization? How do you use a visualization once you've configured it?

In this lesson, you'll learn how to create an instance of your visualization and add that instance to dashboard.

Expand Down Expand Up @@ -66,7 +66,7 @@ Read our [Nerdpacks privileges](/build-apps/permission-manage-apps/) documentati

</Callout>

Next, find your published visualization in the New Relic One app catalog.
Next, find your published visualization in the New Relic One Apps overlay.

</Step>

Expand Down Expand Up @@ -169,7 +169,6 @@ To learn more about custom visualizations, check out the following resources:

Or, to learn more about other cool things you can build with the New Relic One SDK, check out our [apps course](/ab-test)!


<HideWhenEmbedded>

<Callout variant="course">
Expand Down
28 changes: 13 additions & 15 deletions src/markdown-pages/build-apps/build-hello-world-app.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -24,10 +24,6 @@ tags:

Here's how you can quickly build a "Hello, World!" application in New Relic One. In these steps, you create a local version of the New Relic One site where you can prototype your application. Then, when you're ready to share the application with others, you can publish it to New Relic One.

See the video, which demonstrates the steps in this guide in five minutes.

<Video id="7omo0qHxku8" type="youtube" />

</Intro>

## Before you begin
Expand Down Expand Up @@ -108,7 +104,7 @@ As an optional step, you can add a custom launcher icon using any image file nam

<Callout variant="tip">

You will need an icon.png in 2 places for it to be representing properly in the New Relic One Catalog, To set a launcher icon place an icon.png file in the the launcher directory. To set the icon for the app details page place an icon in the root directory of the project.
You will need an icon.png in 2 places for it to be representing properly in Instant Observability, To set a launcher icon place an icon.png file in the the launcher directory. To set the icon for the app details page place an icon in the root directory of the project.

</Callout>

Expand Down Expand Up @@ -152,7 +148,7 @@ Open a browser and go to [https://one.newrelic.com/?nerdpacks=local](https://one

<Step>

When the browser opens, click **Apps**, and then in the **Other apps** section, click the new launcher for your application. Here's an example where we inserted a leaf icon:
When the browser opens, click **Apps**, and then in the **Your apps** section, click the new launcher for your application. Here's an example where we inserted a leaf icon:

![The customized nerdlet launcher](../../images/create-hello-world/hello-world-launcher.png)

Expand All @@ -166,7 +162,7 @@ After you click the new launcher, your "Hello, World!" appears:

## Publish your application to New Relic

Your colleagues can't see your local application, so when you are ready to share it, publish it to the New Relic One catalog. The catalog is where you can find any pre-existing custom applications, as well as any applications you create in your own organization.
Your colleagues can't see your local application, so when you are ready to share it, publish it to Instant Observability. Instant Observability is where you can find any pre-existing custom applications, as well as any applications you create in your own organization.

<Steps>

Expand All @@ -188,25 +184,27 @@ Close your local New Relic One development tab, and open [New Relic One](https:/

<Step>

Click the **Apps** launcher.
Click the **Instant Observability** launcher.

![Navigate to Instant Observability](../../images/serve-publish-subscribe/nav-to-io.png)

</Step>

<Step>

Under **New Relic One catalog**, click the launcher for your new application.
Click the launcher for your new application.

</Step>

</Steps>

When your new application opens, notice that it doesn't display any helpful descriptive information. The next section shows you how to add descriptive metadata.

![An empty application description in the catalog](../../images/create-hello-world/catalog-description-empty.png)
![An empty application description in Instant Observability](../../images/create-hello-world/catalog-description-empty.png)

## Add details to describe your project

Now that your new application is in the New Relic One catalog, you can add details that help users understand what your application does and how to use it.
Now that your new application is in Instant Observability, you can add details that help users understand what your application does and how to use it.

<Steps>

Expand Down Expand Up @@ -236,7 +234,7 @@ In the root `catalog` directory of your project, add screenshots or various type

<Step>

After you add the screenshots and descriptions you want, execute the following to save your metadata to the catalog:
After you add the screenshots and descriptions you want, execute the following to save your metadata to the Instant Observability catalog:

```bash
nr1 catalog:submit
Expand All @@ -246,15 +244,15 @@ nr1 catalog:submit

<Step>

Return to the catalog and refresh the page to see your new screenshots and metadata describing your project.
Return to Instant Observability and refresh the page to see your new screenshots and metadata describing your project.

</Step>

</Steps>

## Subscribe accounts to your application

To make sure other users see your application in the catalog, you need to subscribe accounts to the application. Any user with the NerdPack manager or admin role can subscribe to an application from accounts that they have permission to manage.
To make sure other users see your application in Instant Observability, you need to subscribe accounts to the application. Any user with the NerdPack manager or admin role can subscribe to an application from accounts that they have permission to manage.

<Steps>

Expand Down Expand Up @@ -291,6 +289,6 @@ If you're interested in advanced configurations for your Nerdpack, read [Enable
Now that you've completed the steps in this example, you learned the basic steps to:

- Create a local application.
- Publish the application to the New Relic One catalog so you can share it with your colleagues.
- Publish the application to Instant Observability so you can share it with your colleagues.
- Add details to the project in the catalog so users understand how to use it.
- Subscribe accounts to your application so other users can use it.
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ Each lesson in the course builds upon the last, so make sure you've completed th

</HideWhenEmbedded>

In the last lesson, you created catalog information for the A/B test app you've been building throughout this course. Now, it's time to publish your app to the New Relic One catalog and submit those catalog details.
In the last lesson, you created catalog information for the A/B test app you've been building throughout this course. Now, it's time to publish your app to the Instant Observability catalog and submit those catalog details.

## Versions and tags

Expand Down Expand Up @@ -155,9 +155,9 @@ The results of this command detail the information stored in New Relic's registr

</Steps>

## View your application in the catalog
## View your application in Instant Observability

Now that your application is published and tagged, you can view it in the New Relic One app catalog.
Now that your application is published and tagged, you can view it in the Instant Observability catalog.

<Steps>

Expand All @@ -169,15 +169,15 @@ Go to [New Relic](https://one.newrelic.com). Notice that you're not using the `?

<Step>

From the homepage, navigate to **Apps**:
From the homepage, navigate to **Instant Observability**:

![Navigate to Apps](../../../images/build-an-app/nav-to-apps.png)
![Navigate to Instant Observability](../../../images/serve-publish-subscribe/nav-to-io.png)

From here, you can see your application under **New Relic One catalog**:
From here, you can see your application among the Instant Observability resources:

![Your app in the catalog](../../../images/ab-test/app-in-catalog.png)
![Your app in Instant Observability](../../../images/ab-test/app-in-catalog.png)

Notice that this is different than when you locally served your app. Local apps and published apps you're subscribed to show under **Your apps** instead.
Notice that this is different than when you locally served your app. Local apps and published apps you're subscribed to show under **Your apps** in the Apps overlay instead.

</Step>

Expand Down Expand Up @@ -262,9 +262,9 @@ All the information from _catalog_ shows here.
<Step>
View your app in the catalog:
View your app in Instant Observability:
![Your app in the catalog with metadata](../../../images/ab-test/app-meta-in-catalog.png)
![Your app in Instant Observability with metadata](../../../images/ab-test/app-meta-in-catalog.png)
Notice the tagline on the app's catalog entry.
Expand All @@ -280,7 +280,7 @@ Here, you see app details, a documentation tab, release notes, and screenshots.
## Update your version tag
Your app looks great in the catalog, complete with metadata, images, and documentation. Before, you tagged the app as `DEV` because all of the information wasn't ready for public consumption. Now, it is. It's time to update your version tag.
Your app looks great in the Instant Observability catalog, complete with metadata, images, and documentation. Before, you tagged the app as `DEV` because all of the information wasn't ready for public consumption. Now, it is. It's time to update your version tag.
<Steps>
Expand Down Expand Up @@ -319,15 +319,15 @@ The app is now tagged with `STABLE`, indicating it's ready for public use.
<Callout variant="tip" title="Technical detail">
Even though the app is ready for public use, it's still only visible to users of your account. Other accounts can't see apps created by other private accounts unless those apps are added to the public New Relic One catalog.
Even though the app is ready for public use, it's still only visible to users of your account. Other accounts can't see apps created by other private accounts unless those apps are added to the public Instant Observability catalog.
</Callout>
</Step>
</Steps>
Now that your app is published and its metadata is submitted, you can subscribe your account to the app from the catalog. In the next lesson, you'll learn the ways to subscribe and unsubscribe to your new application.
Now that your app is published and its metadata is submitted, you can subscribe your account to the app from Instant Observability. In the next lesson, you'll learn the ways to subscribe and unsubscribe to your new application.
<HideWhenEmbedded>
Expand All @@ -338,4 +338,3 @@ This lesson is part of a course that teaches you how to build a New Relic One ap
</Callout>
</HideWhenEmbedded>
Original file line number Diff line number Diff line change
Expand Up @@ -17,15 +17,15 @@ Each lesson in the course builds upon the last, so make sure you've completed th

</HideWhenEmbedded>

In the last lesson, you published your A/B test app to the New Relic One catalog. You then submitted your app's description, metadata, documentation, and screenshots. Now, it's time to subscribe your account to the published app.
In the last lesson, you published your A/B test app to the Instant Observability catalog. You then submitted your app's description, metadata, documentation, and screenshots. Now, it's time to subscribe your account to the published app.

## Subscribe to your application

Now that your application is published to the catalog, you can view it by visiting the **Apps** page of [New Relic](https://one.newrelic.com):
Now that your application is published, you can view it by visiting the **Instant Observability** page of [New Relic](https://one.newrelic.com):

![Navigate to Apps](../../../images/build-an-app/nav-to-apps.png)
![Navigate to Instant Observability](../../../images/serve-publish-subscribe/nav-to-io.png)

From the catalog UI, you can subscribe to applications.
From Instant Observability, you can subscribe to applications.

<Steps>

Expand All @@ -49,7 +49,7 @@ This opens the app's **About** page and shows the details you submitted to the c

<Step>

At the top right of this page, click **Add this app**:
At the top left of this page, click **Add this app**:

![Add this app](../../../images/ab-test/add-this-app.png)

Expand Down Expand Up @@ -105,7 +105,7 @@ Click the "i" icon on your app launcher:

![App details from the launcher](../../../images/ab-test/app-details-from-launcher.png)

Here, you see the same app details you saw when your app was in the catalog.
Here, you see the same app details you saw when your app was in the Instant Observability catalog.

</Step>

Expand All @@ -125,13 +125,13 @@ From **Account access**, deselect the account you want to unsubscribe from the a

![Unsubscribe](../../../images/ab-test/unsubscribe.png)

If you navigate back to **Apps**, you will see your app in the catalog.
If you navigate back to **Apps**, you will see your app is no longer under **Your apps**, but can be found again in the Instant Observability catalog.

</Step>

</Steps>

Throughout this course, you've built a New Relic One application from the ground up. You've used the `nr1` CLI to create a Nerdpack, launcher, and Nerdlet. You've used many components from the SDK. You've learned how to publish, tag, subscribe, and unsubscribe to and from apps in the catalog. You've also learned how to submit metadata to the catalog.
Throughout this course, you've built a New Relic One application from the ground up. You've used the `nr1` CLI to create a Nerdpack, launcher, and Nerdlet. You've used many components from the SDK. You've learned how to publish, tag, subscribe, and unsubscribe to and from apps in the Instant Observability catalog. You've also learned how to submit metadata to the catalog.

## Next steps

Expand All @@ -145,4 +145,4 @@ This lesson is the final part of a course that teaches you how to build a New Re

</Callout>

</HideWhenEmbedded>
</HideWhenEmbedded>
Loading

0 comments on commit f949138

Please sign in to comment.