Mlosier/io packdetails refresh #1709

MichelLosier · 2021-09-28T15:55:35Z

Description

Updates guide content and images to the new I/O experience for the following articles:

Create a "Hello, World!" application
Serve, publish, and subscribe to your Nerdpack
- Publish your Nerdpack
- Update your Nerdpack's catalog information
- Serve your Nerdpack
- Subscribe to a Nerdpack
Customize open-source Nerdpacks
Attach your nerdlet to your entities
Customize your visualization with configuration options
Add your custom visualization to a dashboard
a-b test course
- Serve your New Relic One application
- Publish your New Relic One application
- Subscribe to your New Relic One application

Reviewer Notes

If there are links or steps needed to test this work, add them here.

Related Issue(s) / Ticket(s)

If there are any related GitHub Issues or JIRA tickets, add links to them here.

issue

Screenshot(s)

If relevant, add screenshots here.

Use Conventional Commits

Please help the maintainers by leveraging the following conventional commit
standards in your pull request title and commit messages.

Use `chore`

for minor changes / additions / corrections to content.
for minor changes / additions / corrections to images.
for minor non-functional changes / additions to github actions, github templates, package or config updates, etc

git commit -m "chore: adjusting config and content"

Use `fix`

for minor functional corrections to code.

git commit -m "fix: typo and prop error in the code of conduct"

Use `feat`

for major functional changes or additions to code.

git commit -m "feat(media): creating a video landing page"

…ence

… IO experience

…O experience

…perience

gatsby-cloud · 2021-09-28T15:59:20Z

Gatsby Cloud Build Report

developer-website-develop

🎉 Your build was successful! See the Deploy preview here.

Build Details

View the build logs here.

🕐 Build time: 1m

Performance

Lighthouse report

Metric	Score
Performance	🔶 26
Accessibility	💚 90
Best Practices	💚 93
SEO	🔶 76

🔗 View full report

…experience

jpvajda · 2021-09-28T23:04:24Z

I reviewed these changes but will defer to the dev ad team for final review and approval. Thanks for the submission

jaesius

Thanks for submitting all of these changes and refreshing the screenshots

alexronquillo · 2021-09-29T10:51:31Z

Thanks, I'll take a look at these changes this morning!

alexronquillo

Hey @MichelLosier! Thanks for the updates. I think that the changes you've made are great, and I really appreciate the attention to detail with the screenshots. Using a similar aspect ratio to the existing images really helps!

Most of my comments refer not to what you changed, but what you didn't change. It seems like we're moving away from references to the New Relic One catalog because all published Nerdpacks are in Instant Observability now. If that's the case, I think there are a few more changes to make because there are a lot of remaining references to "New Relic One catalog" or just "catalog" across the repo. Would you mind fixing those with this PR, as well?

One more thing is the video in "Create a "Hello, World!" application" is now outdated with these changes. Could you remove that video? I'm going to create a ticket for us to get a new video, but with the introduction of I/O, we think it's just better to remove it for now.

Thanks! Please feel free to push back or clarify something if my understanding is wrong here.

src/markdown-pages/build-apps/build-hello-world-app.mdx

alexronquillo · 2021-09-29T13:23:32Z

src/markdown-pages/build-apps/create-an-ab-test-application/publish.mdx


-![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**:


I think this is a missed reference to the old New Relic One catalog. I'm not sure of the official terminology here, but based on the UI ("Showing 429 resources"), maybe this could read:

From here, you can see your application among the Instant Observability resources:

Also, the next paragraph seems outdated:

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.

It looks to me like you can access subscriptions from Your apps and Instant Observability now, whereas when this was written, it was either in Your apps or New Relic One catalog, but not both.

A paragraph further down the page says:

View your app in the catalog:

Are we ok with calling this "the catalog" or are we trying to move away from that terminology? Maybe we should update this:

View your app in Instant Observability:

Toward the conclusion, this guide says:

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.

I think we want this to say:

...unless those apps are added to Instant Observability.

Similarly, the conclusion says:

Now that your app is published and its metadata is submitted, you can subscribe your account to the app from the catalog.

I think we want:

Now that your app is published and its metadata is submitted, you can subscribe your account to the app from Instant Observability.

@alexronquillo These are great suggestions thank you! I'm curious what kind of place the term catalog still has in this experience, since we do have a Nerdpack artifact called catalog that is purposed around providing Nerdpack metadata for the "catalog".

https://developer.newrelic.com/build-apps/publish-deploy/catalog/

Is there a distinction to made here of "New Relic One catalog" as a named place in the UI that was replaced by "Instant Observability", but that Instant Observability has a "catalog" of resources in a non-proper name sense?

Would it be ok in some instances to say the Instant Observability catalog so that there is still some connection to this idea of a catalog and that aspect of a Nerdpack?

I think you're right that there is a place for "catalog" as it applies to the registry of all published Nerdpacks, the Nerdpack artifact, and the command. I also agree with your distinction and that primarily what we want to change here are references to the New Relic One catalog in the UI.

I'll defer to @jpvajda about whether "Instant Observability catalog" is ok since I haven't really been part of those conversations and could go either way.

Example

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.

Could be written as?:

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.

@alexronquillo Just pushed another pass on this updating the "New Relic One catalog" references to "Instant Observability"

I've also included in places references to "the Instant Observability catalog" to help connect catalog metadata to I/O. Happy to go back and edit those depending on how @jpvajda weighs in.

I've gone through pretty closely and feel like these changes are really solid. Thanks again! Here's another example where "the Instant Observability catalog" feels like the right phrasing since it connects the CLI command / directories in the repo to their UI representation.

alexronquillo · 2021-09-29T13:39:34Z

src/markdown-pages/build-apps/create-an-ab-test-application/subscribe.mdx

@@ -21,9 +21,9 @@ In the last lesson, you published your A/B test app to the New Relic One catalog

 ## 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 to the catalog, you can view it by visiting the **Instant Observability** page of [New Relic](https://one.newrelic.com):


Suggested change

Now that your application is published to the catalog, you can view it by visiting the **Instant Observability** 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):

I'm wondering if "the catalog" is confusing, since it's not used with Instant Observability.

alexronquillo · 2021-09-29T13:40:11Z

src/markdown-pages/build-apps/create-an-ab-test-application/subscribe.mdx


-![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.


Suggested change

From the catalog UI, you can subscribe to applications.

From Instant Observability, you can subscribe to applications.

Further down, this guide mentions "the catalog" a lot. Should we update many (all) of these references as well?

alexronquillo · 2021-09-29T13:54:55Z

src/markdown-pages/build-apps/serve-publish-subscribe/subscribe.mdx


 </Step>

 <Step>

-Find your published Nerdpack under **New Relic One catalog**:
+Find your published Nerdpack using the Apps filter or search bar:


Suggested change

Find your published Nerdpack using the Apps filter or search bar:

Find your published Nerdpack using the apps filter or search bar:

…ility

src/markdown-pages/build-apps/add-visualizations-to-dashboard.mdx

src/markdown-pages/build-apps/build-hello-world-app.mdx

src/markdown-pages/build-apps/create-an-ab-test-application/publish.mdx

src/markdown-pages/build-apps/serve-publish-subscribe/catalog.mdx

tyreer

Looking real good, Michel! Thanks for all the detail-intensive effort here :D

alexronquillo · 2021-09-29T21:55:08Z

Thanks @MichelLosier and @tyreer! 🚀

nr-opensource-bot · 2021-09-29T21:59:04Z

🎉 This PR is included in version 1.57.1 🎉

The release is available on GitHub release

Your semantic-release bot 📦🚀

nr-mlosier added 6 commits September 27, 2021 10:40

chore(build-hello-world-app): update content to reflect new IO experi…

0e2c170

…ence

chore(serve-publish-subscribe-index): update feature apps catalog image

cff71c6

chore(serve-publish-subscribe-catalog): update content to reflect new…

c8bfe9e

… IO experience

chore(serve-publish-subscribe-publish): update content to reflect new…

586d725

… IO experience

chore(serve-publish-subscribe-serve): update content to reflect new I…

404141b

…O experience

chore(serve-publish-subscribe-subscribe): update content to new IO ex…

3ddc841

…perience

MichelLosier added 7 commits September 28, 2021 09:16

chore(customize-open-source-visualization): update content to new io …

d8d17ab

…experience

chore: update image link names that nav to io

2ab7948

chore(attach-nerdlet-to-entities): update content to new io experience

a2ac4d7

fix(customize-visualizations-with-configuration): broken image ref

3627747

chore(ab-test-serve-app): update image to new io experience

630ef9e

chore(ab-test-publish): update content to new IO experience

e91f644

chore(ab-test-subscribe): update content to new IO experience

aea0b84

jpvajda requested review from alexronquillo and jaesius September 28, 2021 22:52

jpvajda requested a review from mehreentahir16 September 28, 2021 23:04

jpvajda added the waiting on contributor label Sep 28, 2021

jpvajda self-assigned this Sep 28, 2021

jaesius previously approved these changes Sep 29, 2021

View reviewed changes

mehreentahir16 previously approved these changes Sep 29, 2021

View reviewed changes

alexronquillo suggested changes Sep 29, 2021

View reviewed changes

MichelLosier added 3 commits September 29, 2021 09:19

chore(build-hello-world-app): remove outdated video

ad40119

chore: update references to New Relic One catalog to Instant Observab…

46e4944

…ility

chore(build-hello-world-app): add nav-to-io image for step

d9601e4

MichelLosier dismissed stale reviews from mehreentahir16 and jaesius via d9601e4 September 29, 2021 18:01

tyreer reviewed Sep 29, 2021

View reviewed changes

src/markdown-pages/build-apps/add-visualizations-to-dashboard.mdx Outdated Show resolved Hide resolved

tyreer marked this pull request as ready for review September 29, 2021 19:02

tyreer reviewed Sep 29, 2021

View reviewed changes

src/markdown-pages/build-apps/build-hello-world-app.mdx Outdated Show resolved Hide resolved

tyreer reviewed Sep 29, 2021

View reviewed changes

src/markdown-pages/build-apps/create-an-ab-test-application/publish.mdx Outdated Show resolved Hide resolved

tyreer reviewed Sep 29, 2021

View reviewed changes

src/markdown-pages/build-apps/serve-publish-subscribe/catalog.mdx Show resolved Hide resolved

tyreer added 3 commits September 29, 2021 14:38

refactor: Revise copy to distinguish between 2 pages

5a48a3c

refactor: Typo in copy

23298a6

refactor: Revise page destination to match next step

c34d318

tyreer approved these changes Sep 29, 2021

View reviewed changes

alexronquillo approved these changes Sep 29, 2021

View reviewed changes

alexronquillo merged commit f949138 into develop Sep 29, 2021

alexronquillo deleted the mlosier/io-packdetails-refresh branch September 29, 2021 21:55

nr-opensource-bot added the released label Sep 29, 2021

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Mlosier/io packdetails refresh #1709

Mlosier/io packdetails refresh #1709

MichelLosier commented Sep 28, 2021 •

edited

Loading

gatsby-cloud bot commented Sep 28, 2021 •

edited

Loading

jpvajda commented Sep 28, 2021

jaesius left a comment

alexronquillo commented Sep 29, 2021

alexronquillo left a comment

alexronquillo Sep 29, 2021

alexronquillo Sep 29, 2021

alexronquillo Sep 29, 2021

alexronquillo Sep 29, 2021

MichelLosier Sep 29, 2021

alexronquillo Sep 29, 2021

MichelLosier Sep 29, 2021

MichelLosier Sep 29, 2021

tyreer Sep 29, 2021

alexronquillo Sep 29, 2021

alexronquillo Sep 29, 2021

alexronquillo Sep 29, 2021

alexronquillo Sep 29, 2021

tyreer left a comment

alexronquillo commented Sep 29, 2021

nr-opensource-bot commented Sep 29, 2021

	Now that your application is published to the catalog, you can view it by visiting the Instant Observability 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):

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

	Find your published Nerdpack using the Apps filter or search bar:
	Find your published Nerdpack using the apps filter or search bar:

Mlosier/io packdetails refresh #1709

Mlosier/io packdetails refresh #1709

Conversation

MichelLosier commented Sep 28, 2021 • edited Loading

Description

Reviewer Notes

Related Issue(s) / Ticket(s)

Screenshot(s)

Use Conventional Commits

Use chore

Use fix

Use feat

gatsby-cloud bot commented Sep 28, 2021 • edited Loading

Gatsby Cloud Build Report

Build Details

Performance

Lighthouse report

jpvajda commented Sep 28, 2021

jaesius left a comment

Choose a reason for hiding this comment

alexronquillo commented Sep 29, 2021

alexronquillo left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

tyreer left a comment

Choose a reason for hiding this comment

alexronquillo commented Sep 29, 2021

nr-opensource-bot commented Sep 29, 2021

MichelLosier commented Sep 28, 2021 •

edited

Loading

Use `chore`

Use `fix`

Use `feat`

gatsby-cloud bot commented Sep 28, 2021 •

edited

Loading