Agrega captura de pantalla, descripciones y otros metadatos a tu Nerdpack y súbelo todo a Observabilidad instantánea.
Actualice su CLI
Antes de ejecutar cualquier comando, cerciorar de tener la última versión de la CLI:
$nr1 update
Comprueba tus licencias
Para publicar tu Nerdpack y actualizar la información de su catálogo, necesitas:
- Acceso a la cuenta que lo publicó.
- Los licencias necesarias para gestionar Nerdpacks.
Publica tu Nerdpack
Debes publicar los Nerdpacks que crees antes de poder actualizar la información de su catálogo.
Actualiza los metadatos del catálogo de tu Nerdpack
Luego de publicar su Nerdpack en el catálogo de observabilidad instantánea , actualice los metadatos del Nerdpack para que el usuario sepa todo sobre sus Nerdlets o visualizaciones.
{ "tagline": "", "details": "", "categoryTerms": [], "keywords": [], "repository": "", "whatsNew": "", "support": { "email": { "address": "" }, "issues": { "url": "" }, "community": { "url": "" } }}
Desde la página de inicio de New Relic , vaya a + Integrations & Agents en la barra de navegación superior.
Encuentra tu Nerdpack publicado usando el filtro de aplicaciones o la barra de búsqueda. Tenga en cuenta que no hay información o página de detalles aparte del nombre del Nerdpack y la breve descripción que se encuentra en nr1.json
. No hay captura de pantalla, íconos, detalles ni características nuevas. Para estos, debes proporcionar información del catálogo a tu Nerdpack.
Desde la raíz de tu Nerdpack, crea directorios de catálogo para albergar la captura de pantalla y los metadatos de tu Nerdpack:
$nr1 create --type catalog✔ created: launchers/launcher/catalog✔ created: nerdlets/home/catalog✔ catalog created successfully! catalog is available at "./catalog"
Dentro de su directorio raíz catalog
, encontrará archivos y directorios específicos para mostrar información sobre su Nerdpack a su usuario:
$ls catalogREADME.md additionalInfo.md config.json documentation.md screenshots
Archivo | Descripción |
---|---|
README.md | Un archivo de rebajas que le indica cómo emplear la información y los metadatos del catálogo. |
config.json | Un archivo JSON que contiene los siguientes campos:
|
documentation.md | Un archivo de rebajas que le dice al usuario cómo usar los Nerdlets o visualizaciones de Nerdpack. Esto se muestra en la pestaña Documentation de la vista detallada. |
additionalInfo.md | Un archivo de rebajas opcional para cualquier información adicional sobre el uso de su aplicación. |
captura de pantalla | Un directorio que contiene captura de pantalla que muestra tu Nerdpack, como imágenes seleccionadas de Nerdlets o visualizaciones. Este no puede contener más de 6 imágenes. Toda captura de pantalla debe cumplir con los siguientes criterios:
|
Este comando también genera un directorio catalog
para cada iniciador, Nerdlet y visualización en su Nerdpack. Dentro encontrarás un directorio que te permite agregar captura de pantalla para cada elemento de Nerdpack.
$ls launchers/launcher/catalogscreenshots$ls nerdlets/home/catalogscreenshots
Actualiza el archivo documentation.md
de tu Nerdpack:
Enter your first and last name into the fields provided. When you're done, press **Submit** to see a personalized "Hello!" message.
Actualice su archivo config.json
:
{ "tagline": "Say hi!", "details": "DemoApp says Hello to a user.", "categoryTerms": [], "keywords": ["hello world"], "repository": "https://github.com/newrelic/developer-website", "whatsNew": "feat: Initial commit"}
Incluye captura de pantalla en tu directorio raíz screenshots
o en cualquier directorio de elementos screenshots
de Nerdpack.
Envíe la información al catálogo de Observabilidad Instantánea:
$nr1 catalog:submitUploading screenshots from demo-app... ✔ Screenshots uploaded from: demo-appUploading screenshots from demo-app/launchers/launcher... ✔ Screenshots uploaded from: demo-app/launchers/launcherUploading screenshots from demo-app/nerdlets/home... ✔ Screenshots uploaded from: demo-app/nerdlets/home ✔ Updated metadata for DemoApp 1.0.0
Vaya a Observabilidad instantánea para ver sus cambios. Haz clic en tu Nerdpack para ver los nuevos detalles. Luego, haz clic en What's inside para ver cualquier captura de pantalla que subiste para elementos individuales en tu Nerdpack.
Actualiza los íconos de tu Nerdpack
Dentro de un Nerdpack, puedes configurar dos tipos de íconos:
- Uno para todo tu Nerdpack, que representa tu Nerdpack en el catálogo.
- Uno para cada uno de tus pícher, que representa a tus Nerdlets.
Reemplace estos íconos y publique su Nerdpack para ver los cambios.
Actualiza el icon.png
en la raíz de tu Nerdpack. Este icono se emplea en el catálogo y en la página de detalles de Nerdpack.
Si estás creando un Nerdpack con uno o más pícher, actualiza el icon.png
en cada una de las subcarpetas de tu pícher.
Actualice su versión package.json
:
{ "private": true, "name": "demo-app", "version": "1.0.1", "scripts": { "start": "nr1 nerdpack:serve", "test": "exit 0" }, "nr1": { "uuid": "f2dbc999-e9a3-49b9-933d-5a704c6750bd" }, "dependencies": { "prop-types": "^15.6.2", "react": "^16.6.3", "react-dom": "^16.6.3" }, "browserslist": ["last 2 versions", "not ie < 11", "not dead"]}
Esto te permite publicar una nueva versión de tu Nerdpack.
Publica tu Nerdpack:
$nr1 nerdpack:publish
Actualice su cadena whatsNew
en catalog/config.json
:
{ "tagline": "Say hi!", "details": "DemoApp says Hello to a user.", "categoryTerms": [], "keywords": ["hello world"], "repository": "https://github.com/newrelic/developer-website", "whatsNew": "feat: Add new icons"}
Esto le dirá al usuario lo que agregó en la última versión de su Nerdpack.
Envíe estos nuevos metadatos al catálogo:
$nr1 catalog:submitUploading screenshots from demo-app... ✔ Screenshots uploaded from: demo-appUploading screenshots from demo-app/launchers/launcher... ✔ Screenshots uploaded from: demo-app/launchers/launcherUploading screenshots from demo-app/nerdlets/home... ✔ Screenshots uploaded from: demo-app/nerdlets/home ✔ Updated metadata for DemoApp 1.0.1
Ve al catálogo y suscríbete a tu Nerdpack para ver tu nuevo icono.
Resolver problemas con el envío de información del catálogo
A veces, cuando trabaja con metadatos de catálogo, puede tener problemas. Considere algunas soluciones comunes para resolver estos problemas.
Publica tu Nerdpack
Recuerda que solo puedes enviar metadatos de catálogo para Nerdpacks que ya fueron publicados. Si intentas enviar información para un Nerdpack que no se publicó, la CLI intentará ayudarte:
$nr1 catalog:submitUploading screenshots... › Error: 1 error while updating DemoApp 1.0.0 › › Invalid Version: Nerdpack version 1.0.0 not found. Have you run `nr1 nerdpack:publish` yet? › Code: UNKNOWN
Cambia el tamaño de tus imágenes
La captura de pantalla para el catálogo debe cumplir con los criterios especificados anteriormente en esta guía. Si no es así, la CLI intentará ayudar:
$nr1 catalog:submitUploading screenshots... › Error: 2 errors while updating DemoApp 1.0.1 › › catalog/screenshots/screenshot.png › Invalid Screenshot: screenshot.png has a size ratio of 4:2. Update size ratio to 3:2. › › catalog/screenshots/screenshot.png › Invalid Screenshot: screenshot.png has a width of 3054px. Update size to be between 1600px and 2400px. › Code: UNKNOWN
Comprueba la longitud de tus cuerdas.
La mayor parte del contenido de config.json
tiene requisitos de longitud de cadena. Cerciorar de revisar esos requisitos y cumplirlos cuando actualice su archivo config.json
. De lo contrario, verá errores cuando intente enviar su configuración al catálogo:
$nr1 catalog:submitUploading screenshots... ✔ Screenshots uploaded › Error: 2 errors while updating DemoApp 1.0.1 › › catalog/config.json › Invalid Metadata: `details` has a character length of 2204. Must be no longer than 1000 characters › › catalog/config.json › Invalid Metadata: `tagline` has a character length of 266. Must be no longer than 30 characters › Code: UNKNOWN