スクリーンショット、説明、その他の情報を Nerdpack に追加し、すべてをInstant Appにアップロードします。
CLIを更新する
コマンドを実行する前に、CLI の最新バージョンがインストールされていることを確認してください。
$nr1 update
権限を確認してください
Nerdpack を公開し、カタログ情報を更新するには、次のものが必要です。
- 公開したアカウントへのアクセス。
- Nerdpacks を管理するために必要な権限。
Nerdpackを公開する
カタログ情報を更新する前に、作成した Nerdpackを公開する必要があります。
Nerdpackのカタログメタデータを更新する
Nerdpack をInstant オブザーバビリティカタログに公開したら、Nerdpack のメタデータを更新して、Nerdlet または視覚化についてユーザーにすべて知らせます。
{ "tagline": "", "details": "", "categoryTerms": [], "keywords": [], "repository": "", "whatsNew": "", "support": { "email": { "address": "" }, "issues": { "url": "" }, "community": { "url": "" } }}
New Relicホームページから、上部のナビゲーション バーの+ Integrations & Agentsに移動します。
アプリ フィルターまたは検索バーを使用して、公開済みの Nerdpack を見つけます。 Nerdpack の名前とnr1.json
にある簡単な説明以外には、情報や詳細ページがないことに注意してください。 スクリーンショット、アイコン、詳細、新機能などはありません。 これらについては、Nerdpack にカタログ情報を提供する必要があります。
Nerdpack のルートから、Nerdpack のスクリーンショットとメタデータを格納するカタログディレクトリを作成します。
$nr1 create --type catalog✔ created: launchers/launcher/catalog✔ created: nerdlets/home/catalog✔ catalog created successfully! catalog is available at "./catalog"
ルートcatalog
ディレクトリ内には、Nerdpack に関する情報をユーザーに表示するための特定のファイルとディレクトリがあります。
$ls catalogREADME.md additionalInfo.md config.json documentation.md screenshots
ファイル | 説明 |
---|---|
README.md | カタログ内の情報とメタデータの使用方法を説明するマークダウンファイル |
config.json | 次のフィールドを含む JSON ファイル:
|
ドキュメント | Nerdpack の Nerdlets または視覚化の使用方法をユーザーに伝えるマークダウン ファイル。 これは詳細ビューのDocumentation [ドキュメント]タブに表示されます。 |
追加情報.md | アプリケーションの使用に関する追加情報のためのオプションのマークダウンファイル |
スクリーンショット | Nerdlets や視覚化の選択画像など、Nerdpack を紹介するスクリーンショットを含むディレクトリ。 含められる画像は 6 枚までです。 すべてのスクリーンショットは次の基準を満たしている必要があります。
|
このコマンドは、Nerdpack 内の各ランチャー、Nerdlet、視覚化に対してcatalog
ディレクトリも生成します。 内部には、Nerdpack の各アイテムのスクリーンショットを追加できるディレクトリがあります。
$ls launchers/launcher/catalogscreenshots$ls nerdlets/home/catalogscreenshots
Nerdpack のdocumentation.md
ファイルを更新します:
Enter your first and last name into the fields provided. When you're done, press **Submit** to see a personalized "Hello!" message.
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"}
スクリーンショットをルートscreenshots
ディレクトリまたは Nerdpack アイテムscreenshots
ディレクトリに含めます。
情報を Instant of servability カタログに送信します。
$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
変更を確認するには、「インスタント アクセシビリティ」に移動します。 新しい詳細を表示するには、Nerdpack をクリックしてください。 次に、 What's insideをクリックすると、Nerdpack 内の個々のアイテムにアップロードしたスクリーンショットが表示されます。
Nerdpackのアイコンを更新する
Nerdpack 内では、次の 2 種類のアイコンを設定できます。
- 1 つは Nerdpack 全体用で、カタログ内で Nerdpack を表します。
- ランチャーごとに 1 つずつあり、Nerdlets を表します。
これらのアイコンを置き換えて Nerdpack を公開し、変更を確認してください。
Nerdpack のルートにあるicon.png
を更新します。 このアイコンはカタログと Nerdpack の詳細ページで使用されます。
1 つ以上のランチャーを含む Nerdpack をビルドする場合は、各ランチャーのサブフォルダー内のicon.png
を更新します。
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"]}
これにより、Nerdpack の新しいバージョンを公開できるようになります。
Nerdpackを公開する:
$nr1 nerdpack:publish
catalog/config.json
のwhatsNew
文字列を更新します:
{ "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"}
これにより、最新バージョンの Nerdpack に何を追加したかがユーザーに伝わります。
この新しいメタデータをカタログに送信します。
$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
新しいアイコンを表示するには、カタログにアクセスしてNerdpack をサブスクライブしてください。
カタログ情報の送信に関する問題を解決する
カタログ メタデータを操作するときに、問題が発生することがあります。 これらの問題を解決するための一般的な解決策をいくつか検討してください。
Nerdpackを公開する
すでに公開されている Nerdpacks のカタログ メタデータのみを送信できることに注意してください。 公開されていない Nerdpack の情報を送信しようとすると、CLI が支援を試みます:
$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
画像のサイズを変更する
カタログのスクリーンショットは、このガイドで前述した基準を満たしている必要があります。 そうでない場合は、CLI が支援を試みます:
$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
弦の長さを確認する
config.json
のコンテンツのほとんどには文字列の長さの要件があります。 config.json
ファイルを更新するときは、必ずこれらの要件を確認し、それに従ってください。 そうしないと、設定をカタログに送信しようとするとエラーが表示されます。
$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