Atualize as informações do catálogo do seu Nerdpack

Adicione captura de tela, descrições e outros metadados ao seu Nerdpack, e carregue tudo no Instant observabilidade.

Atualize sua CLI

Antes de executar qualquer comando, certifique-se de ter a versão mais recente da CLI:

bash

$nr1 update

Verifique suas permissões

Para publicar seu Nerdpack e atualizar as informações do catálogo, você precisa de:

Acesso à conta que o publicou.
As permissões necessárias para gerenciar Nerdpacks.

Publique seu Nerdpack

Você precisa publicar os Nerdpacks criados antes de atualizar as informações do catálogo.

Atualize os metadados do catálogo do seu Nerdpack

Após publicar seu Nerdpack no catálogo de observabilidade Instant , atualize os metadados do Nerdpack para que o usuário saiba tudo sobre seus Nerdlets ou visualizações.

{
  "tagline": "",
  "details": "",
  "categoryTerms": [],
  "keywords": [],
  "repository": "",
  "whatsNew": "",
  "support": {
    "email": {
      "address": ""
    },
    "issues": {
      "url": ""
    },
    "community": {
      "url": ""
    }
  }
}

catalog/config.json

Na página inicial do New Relic , vá para + Integrations & Agents na barra de navegação superior.

Encontre seu Nerdpack publicado usando o filtro de aplicativos ou a barra de pesquisa. Observe que não há nenhuma página de informações ou detalhes além do nome do Nerdpack e a breve descrição encontrada em nr1.json. Não há captura de tela, ícones, detalhes ou recurso de novidades. Para isso, você precisa fornecer informações do catálogo ao seu Nerdpack.

A partir da raiz do seu Nerdpack, crie diretórios de catálogo para abrigar as capturas de tela e metadados do seu Nerdpack:

bash

$nr1 create --type catalog
✔  created: launchers/launcher/catalog
✔  created: nerdlets/home/catalog
✔  catalog created successfully!
   catalog is available at "./catalog"

Dentro do seu diretório raiz catalog , você encontrará arquivos e diretórios específicos para transmitir informações sobre o seu Nerdpack ao seu usuário:

bash

$ls catalog
README.md         additionalInfo.md config.json       documentation.md  screenshots

Arquivo	Descrição
README.md	Um arquivo markdown que instrui como usar as informações e os metadados no catálogo
config.json	Um arquivo JSON que contém os seguintes campos: `tagline`: Um breve título para o aplicativo. Não pode exceder 30 caracteres. `repository`: A URL do repositório remoto do Nerdpack. Não pode exceder 1000 caracteres. `details`: O objetivo do Nerdpack e como usá-lo. Não pode exceder 1000 caracteres. Use novas linhas para formatação e não inclua nenhuma marcação ou HTML. `categoryTerms`: Uma lista de termos que correspondem o Nerdpack a uma categoria no catálogo de observabilidade Instantânea . Você pode procurar um mapeamento de termos de categoria com NerdGraph: Consulta dos EUA Consulta da UE `keywords`: Uma lista de palavras relevantes para melhorar a descoberta de pesquisa do Nerdpack. Não pode exceder 50 palavras e cada palavra não pode exceder 64 caracteres. `support`: Um objeto que contém: `issues`: Uma URL para a lista de problemas do repositório. Por exemplo, a guia Issues se estiver usando o GitHub. `email`: Um endereço de e-mail válido para a equipe que dá suporte ao aplicativo. `community`: Uma URL para um tópico de suporte, fórum ou site para resolução de problemas e suporte ao uso. `whatsNew`: Uma lista com marcadores de alterações na versão atual. Não pode exceder 500 caracteres. Use novas linhas para formatação e não inclua markdown ou HTML. Confira `config.json`do nosso aplicativo Pageview Map para ver uma implementação real.
documentation.md	Um arquivo markdown que informa ao usuário como usar os Nerdlets ou visualizações do Nerdpack. Isso é mostrado na guia Documentation da visualização detalhada.
additionalInfo.md	Um arquivo markdown opcional para qualquer informação adicional sobre como usar seu aplicativo
captura de tela	Um diretório que contém capturas de tela mostrando seu Nerdpack, como imagens selecionadas de Nerdlets ou visualizações. Não pode conter mais de 6 imagens. Toda captura de tela deve atender aos seguintes critérios: proporção de aspecto 3:2 formato PNG orientação paisagem 1600 a 2400 pixels de largura

Este comando também gera um diretório catalog para cada launcher, Nerdlet e visualização em seu Nerdpack. Dentro você encontrará um diretório que permite adicionar captura de tela para cada item do Nerdpack.

bash

$ls launchers/launcher/catalog
screenshots
$ls nerdlets/home/catalog
screenshots

Atualize o arquivo documentation.md do seu Nerdpack:

Enter your first and last name into the fields provided. When you're done, press **Submit** to see a personalized "Hello!" message.

catalog/documentation.md

Atualize seu arquivo 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"
}

catalog/config.json

Inclua captura de tela em seu diretório raiz screenshots ou em qualquer diretório de item screenshots do Nerdpack.

Envie as informações para o catálogo de observabilidade Instantânea:

bash

$nr1 catalog:submit
Uploading screenshots from demo-app...
 ✔  Screenshots uploaded from: demo-app
Uploading screenshots from demo-app/launchers/launcher...
 ✔  Screenshots uploaded from: demo-app/launchers/launcher
Uploading screenshots from demo-app/nerdlets/home...
 ✔  Screenshots uploaded from: demo-app/nerdlets/home
 ✔  Updated metadata for DemoApp 1.0.0

Vá para Observabilidade instantânea para ver suas alterações. Clique no seu Nerdpack para ver os novos detalhes. Em seguida, clique em What's inside para ver qualquer captura de tela que você carregou para itens individuais em seu Nerdpack.

Atualize os ícones do seu Nerdpack

Dentro de um Nerdpack, você pode definir dois tipos de ícones:

Um para todo o seu Nerdpack, que representa o seu Nerdpack no catálogo.
Um para cada um dos seus lançadores, que representa seus Nerdlets.

Substitua esses ícones e publique seu Nerdpack para ver as mudanças.

Atualize o icon.png na raiz do seu Nerdpack. Este ícone é usado no catálogo e na página de detalhes do Nerdpack.

Se você estiver criando um Nerdpack com um ou mais inicializadores, atualize o icon.png em cada uma das subpastas do seu inicializador.

Atualize sua versão do 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"]
}

package.json

Isso permite que você publique uma nova versão do seu Nerdpack.

Publique seu Nerdpack:

bash

$nr1 nerdpack:publish

Atualize sua string whatsNew em 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"
}

catalog/config.json

Isso informará ao usuário o que você adicionou na versão mais recente do seu Nerdpack.

Envie esses novos metadados para o catálogo:

bash

$nr1 catalog:submit
Uploading screenshots from demo-app...
 ✔  Screenshots uploaded from: demo-app
Uploading screenshots from demo-app/launchers/launcher...
 ✔  Screenshots uploaded from: demo-app/launchers/launcher
Uploading screenshots from demo-app/nerdlets/home...
 ✔  Screenshots uploaded from: demo-app/nerdlets/home
 ✔  Updated metadata for DemoApp 1.0.1

Acesse o catálogo e assine seu Nerdpack para ver seu novo ícone.

Resolver problemas com o envio de informações do catálogo

Às vezes, ao trabalhar com metadados de catálogo, você pode encontrar problemas. Considere algumas soluções comuns para resolver esses problemas.

Publique seu Nerdpack

Lembre-se de que você só pode enviar metadados de catálogo de Nerdpacks que já foram publicados. Se você tentar enviar informações de um Nerdpack que ainda não foi publicado, a CLI tentará ajudar:

bash

$nr1 catalog:submit
Uploading 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

Redimensione suas imagens

A captura de tela para o catálogo deve atender aos critérios especificados anteriormente neste guia. Caso contrário, a CLI tentará ajudar:

bash

$nr1 catalog:submit
Uploading 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

Verifique o comprimento de suas cordas

A maior parte do conteúdo em config.json possui requisitos de comprimento de string. Certifique-se de revisar esses requisitos e cumpri-los ao atualizar seu arquivo config.json . Caso contrário, você verá erros ao tentar enviar sua configuração ao catálogo:

bash

$nr1 catalog:submit
Uploading 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

Esta tradução de máquina é fornecida para sua comodidade.

Atualize as informações do catálogo do seu Nerdpack

Atualize sua CLI .css-21sua1{background:none;border:none;width:0;padding:0;}

Verifique suas permissões

Publique seu Nerdpack

Atualize os metadados do catálogo do seu Nerdpack

Atualize os ícones do seu Nerdpack

Resolver problemas com o envio de informações do catálogo

Publique seu Nerdpack

Redimensione suas imagens

Verifique o comprimento de suas cordas

Atualize sua CLI