Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Lucia/update nerdpack detail docs #1748

Merged
merged 28 commits into from
Nov 16, 2021
Merged
Show file tree
Hide file tree
Changes from 13 commits
Commits
Show all changes
28 commits
Select commit Hold shift + click to select a range
ecc177f
chore: add screenshot of what's inside tab
brammerl Oct 4, 2021
68b7ce9
chore: fix spacing
brammerl Oct 4, 2021
460100a
chore: update whats-inside-nerdlet-tab image
brammerl Oct 4, 2021
dcdc841
chore: add screenshots to 'Describe your app for catalog'
brammerl Oct 4, 2021
3e7b9d9
chore: fix image sourcing
brammerl Oct 4, 2021
1a29eac
chore: update implementing feedback given
brammerl Oct 6, 2021
4f651f0
fixing spacing
brammerl Oct 6, 2021
ef1dd47
updating photo reference and photo
brammerl Oct 6, 2021
7e34724
chore: remove image reference
brammerl Oct 6, 2021
6ea8c89
chore: remove image
brammerl Oct 6, 2021
a376e04
chore: add screenshots to create world app page
brammerl Oct 6, 2021
e80e3e8
chore: fix sourcing and image style
brammerl Oct 6, 2021
3937bd5
chore: dimage reference updates
brammerl Oct 6, 2021
a19bb2a
Update src/markdown-pages/build-apps/serve-publish-subscribe/catalog.mdx
brammerl Oct 8, 2021
2e25878
chore: remove unused images
brammerl Oct 8, 2021
56e76d3
chore: replace whats inside image
brammerl Oct 8, 2021
329466b
chore: rephrase step 3/5 in add details to describe your project
brammerl Oct 8, 2021
d2dc3d3
chore: changing verbiage within describe your app for the catalog
brammerl Oct 8, 2021
4943a6e
Update build-hello-world-app.mdx
brammerl Oct 8, 2021
30e0d8e
Update build-hello-world-app.mdx
brammerl Oct 8, 2021
0ca1ac7
Update src/markdown-pages/build-apps/serve-publish-subscribe/catalog.mdx
brammerl Oct 12, 2021
724639d
chore: add screenshot to ab-test publish documentation
brammerl Oct 15, 2021
efcfcb0
chore: italicize directory reference
brammerl Oct 15, 2021
6b1541f
chore: add descriptive text between images
brammerl Oct 15, 2021
928016d
chore: add text between images in publish section for ab-test
brammerl Oct 15, 2021
e116bee
chore: small language fix
mehreentahir16 Oct 27, 2021
a23d06e
chore: updated screenshot
mehreentahir16 Oct 28, 2021
56bbf18
Merge branch 'develop' into lucia/update-nerdpack-detail-docs
brammerl Nov 16, 2021
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
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/ab-test/ab-testing-logo-overview.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/whats-inside-tab.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.
Binary file added src/images/create-hello-world/io-view.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
4 changes: 4 additions & 0 deletions src/markdown-pages/build-apps/build-hello-world-app.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -246,6 +246,10 @@ nr1 catalog:submit

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

![Overview View](../../images/create-hello-world/hello-world-overview.png)

![What's Inside View](../../images/create-hello-world/hello-world-whats-inside.png)
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I agree that this seems like a good guide place to mention Nerdpack-item level screenshots

2 suggestions:

  1. Could you add copy to step 3 that describes include Nerdpack-item screenshots? As is, I don't think there's any guidance that the reader should add any images to these directories, so I think the What's inside tab would actually be empty if they clicked it

How we change it to something like:

STEP 3 OF 5
In the root catalog directory of your project, add screenshots or various types of metadata to describe your project. You can also add screenshots in the catalog directories of your launcher or Nerdlet. For details about what you can add, see Update your Nerdpack's catalog metadata

Note that the above suggestion also updates the title and link at the end of step 3, since it seemed to be outdated.

  1. This bottom screen shot, pointing to the What's inside tab, has Apps as its root breadcrumb. For consistency here, and especially since step 5 indicates explicitly that we're coming from I/O, could you replace this screenshot with one where Instant Observability (I/O) is the root breadcrumb?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Typically, when there are two screenshots in a row, I like to add some text between them for a transition and for visual relief. Could we maybe add:

And if you added screenshots to your launcher or Nerdlet, you can see them under What's inside:

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@brammerl would you mind addressing my comment here, as well? I think the second screenshot here could really benefit from its own description.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.


</Step>

</Steps>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -201,6 +201,10 @@ Click your Nerdpack to see the new details:

![App details](../../../images/serve-publish-subscribe/demo-app-details.png)

Click the **What's inside** tab to see any screenshots you uploaded for individual items in your Nerdpack"

![What's Inside Tab](../../../images/build-an-app/whats-inside-tab.png)

</Step>

</Steps>
Expand Down