Ajoutez des captures d'écran, des descriptions et d'autres métadonnées à votre Nerdpack et téléchargez le tout sur Instant observabilité.
Mettez à jour votre CLI
Avant d’exécuter des commandes, assurez-vous que vous disposez de la dernière version de la CLI :
$nr1 update
Vérifiez vos autorisations
Pour publier votre Nerdpack et mettre à jour les informations de son catalogue, vous avez besoin de :
- Accédez au compte qui l'a publié.
- Les autorisations nécessaires à la gestion des Nerdpacks.
Publiez votre Nerdpack
Vous devez publier les Nerdpacks que vous créez avant de pouvoir mettre à jour leurs informations de catalogue.
Mettez à jour les métadonnées du catalogue de votre Nerdpack
Après avoir publié votre Nerdpack dans le catalogue Instant Observabilité , mettez à jour la métadonnées du Nerdpack pour permettre à l'utilisateur de tout savoir sur vos Nerdlets ou visualisations.
{ "tagline": "", "details": "", "categoryTerms": [], "keywords": [], "repository": "", "whatsNew": "", "support": { "email": { "address": "" }, "issues": { "url": "" }, "community": { "url": "" } }}
Depuis la page d’accueil de New Relic , accédez à + Integrations & Agents dans la barre de navigation supérieure.
Trouvez votre Nerdpack publié en utilisant le filtre des applications ou la barre de recherche. Notez qu'il n'y a aucune page d'informations ou de détails autres que le nom du Nerdpack et la brève description trouvée dans nr1.json
. Il n'y a pas de capture d'écran, d'icônes, de détails ou de fonctionnalités nouvelles. Pour ceux-ci, vous devez fournir des informations de catalogue à votre Nerdpack.
Depuis la racine de votre Nerdpack, créez des répertoires de catalogue pour héberger la capture d'écran et les métadonnées de votre Nerdpack :
$nr1 create --type catalog✔ created: launchers/launcher/catalog✔ created: nerdlets/home/catalog✔ catalog created successfully! catalog is available at "./catalog"
Dans votre répertoire racine catalog
, vous trouverez des fichiers et des répertoires spécifiques pour transmettre des informations sur votre Nerdpack à votre utilisateur :
$ls catalogREADME.md additionalInfo.md config.json documentation.md screenshots
Déposer | Description |
---|---|
README.md | Un fichier Markdown qui vous indique comment utiliser les informations et les métadonnées du catalogue |
config.json | Un fichier JSON contenant les champs suivants :
|
documentation.md | Un fichier Markdown qui indique à l'utilisateur comment utiliser les Nerdlets ou les visualisations du Nerdpack. Cela s'affiche dans l'onglet Documentation de la vue détaillée. |
additionalInfo.md | Un fichier markdown facultatif pour toute information supplémentaire sur l'utilisation de votre application |
capture d'écran | Un répertoire qui contient des captures d'écran présentant votre Nerdpack, telles que des images sélectionnées de Nerdlets ou des visualisations. Cela ne peut pas contenir plus de 6 images. Toutes les captures d'écran doivent répondre aux critères suivants :
|
Cette commande génère également un répertoire catalog
pour chaque lanceur, Nerdlet et visualisation dans votre Nerdpack. À l'intérieur, vous trouverez un répertoire qui vous permet d'ajouter une capture d'écran pour chaque élément Nerdpack.
$ls launchers/launcher/catalogscreenshots$ls nerdlets/home/catalogscreenshots
Mettez à jour le fichier documentation.md
de votre Nerdpack :
Enter your first and last name into the fields provided. When you're done, press **Submit** to see a personalized "Hello!" message.
Mettez à jour votre fichier 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"}
Incluez la capture d'écran dans votre répertoire racine screenshots
ou dans n'importe quel répertoire d'éléments Nerdpack screenshots
.
Soumettez les informations au catalogue Instant Observability :
$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
Accédez à Instant Observability pour voir vos modifications. Cliquez sur votre Nerdpack pour voir les nouveaux détails. Ensuite, cliquez sur What's inside pour voir toute capture d'écran que vous avez téléchargée pour des éléments individuels de votre Nerdpack.
Mettez à jour les icônes de votre Nerdpack
Dans un Nerdpack, vous pouvez définir deux types d'icônes :
- Un pour l'ensemble de votre Nerdpack, qui représente votre Nerdpack dans le catalogue.
- Un pour chacun de vos lanceurs, qui représente vos Nerdlets.
Remplacez ces icônes et publiez votre Nerdpack pour voir les changements.
Mettez à jour le icon.png
dans la racine de votre Nerdpack. Cette icône est utilisée dans le catalogue et la page de détails du Nerdpack.
Si vous créez un Nerdpack avec un ou plusieurs lanceurs, mettez à jour le icon.png
dans chacun des sous-dossiers de votre lanceur.
Mettez à jour votre version 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"]}
Cela vous permet de publier une nouvelle version de votre Nerdpack.
Publiez votre Nerdpack :
$nr1 nerdpack:publish
Mettez à jour votre chaîne whatsNew
dans 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"}
Cela indiquera à l'utilisateur ce que vous avez ajouté dans la dernière version de votre Nerdpack.
Soumettre ces nouvelles métadonnées au catalogue :
$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
Accédez au catalogue et abonnez-vous à votre Nerdpack pour voir votre nouvelle icône.
Résoudre les problèmes liés à la soumission des informations du catalogue
Parfois, lorsque vous travaillez avec des métadonnées de catalogue, vous pouvez rencontrer des problèmes. Envisagez quelques solutions courantes pour résoudre ces problèmes.
Publiez votre Nerdpack
N'oubliez pas que vous ne pouvez soumettre des métadonnées de catalogue que pour les Nerdpacks qui ont déjà été publiés. Si vous essayez de soumettre des informations pour un Nerdpack qui n'a pas été publié, la CLI essaiera de vous aider :
$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
Redimensionnez vos images
La capture d'écran du catalogue doit répondre aux critères précisés précédemment dans ce guide. Si ce n'est pas le cas, la CLI essaiera de vous aider :
$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
Vérifiez la longueur de vos cordes
La plupart du contenu de config.json
a des exigences de longueur de chaîne. Assurez-vous de vérifier ces exigences et de les respecter lorsque vous mettez à jour votre fichier config.json
. Sinon, vous verrez des erreurs lorsque vous tenterez de soumettre votre configuration au catalogue :
$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