管理と有効化プラットフォーム内カスタムドキュメント新しいカスタムドキュメントバンドルを追加する

注: 以下の翻訳の正確性は検証されていません。AIPを利用して英語版の原文から機械的に翻訳されたものです。

新しいカスタムドキュメントバンドルを追加する

プラットフォーム内のカスタムドキュメントは「バンドル」として構成され、「バンドル」は一緒に公開され、ナビゲーションでリンクされるドキュメントページのセットです。各バンドルには、最低限、ユーザーがカスタムドキュメントのホームページからバンドルに移動する際のランディングページとして機能する概要ページ(overview.md)と、バンドル内のページ構造を指定する順序ファイル(ordering.md)が必要です。

新しいバンドルを作成する

すべてのドキュメントファイルはカスタムドキュメントリポジトリの docs フォルダーに保存する必要があります。まだカスタムドキュメントリポジトリを持っていない場合は、新しいカスタムドキュメントリポジトリを作成する手順に従ってください。

Code Repositories の「docs」フォルダーを示すスクリーンショット。

カスタムドキュメントリポジトリに新しいバンドルを追加するには、docs フォルダー内にドキュメントバンドルの内容を表す名前の新しいフォルダーを作成します(たとえば、inventory-management-application)。フォルダーファイル名は一意であり、スペースを含めることはできません。このフォルダーはバンドルのプロダクトIDとして使用されます。

バンドルの新しいフォルダー内で:

  • overview.md というファイルを作成します。詳細は以下の例を参照してください。
    • overview.md には、@name アノテーションを使用してプロダクトバンドルの名前を宣言します。これはユーザー向けのプラットフォーム内カスタムドキュメントでバンドルの名前として表示されます。
    • overview.md には、@description アノテーションを使用してプロダクトの短い説明を提供します。
    • overview.md には、読者を導き、プロダクトのコア目的やワークフローに関する文脈を提供するためのいくつかの紹介文を含めます。
  • ordering.md というファイルを作成し、このファイルを使用してコンテンツの構造を宣言します。overview.md はデフォルトで存在する必要があるため、ordering.md には表示されません。ドキュメントバンドルの構造化に関するドキュメントを参照してください。

@name@description アノテーションで指定された名前と説明は、 <ユーザーのエンロールメント>/workspace/documentation のプラットフォーム内カスタムドキュメントホームページにあるドキュメントバンドルのリストに表示されます。

Code Repositories のカスタムドキュメントフォルダー内の「overview.md」を示すスクリーンショット。

overview.md の例

以下は Contour の overview.md の例です。この例の overview.md には、@name、短い @description、およびプロダクトに関する紹介文が含まれています。

@name Contour
@description ポイント&クリックによる大規模データ分析

Contourは、大規模なテーブルデータの分析を行うためのポイント&クリックユーザーインターフェースを提供します。これらの分析は、他のユーザーがデータをガイド付きかつ構造化された方法で探索および調査できるインタラクティブな[ダッシュボード](@contour/dashboards-overview)を作成するために使用できます。

## 主要な機能

Contourを使用すると、以下のことが可能です:

* コードなしでデータを視覚化、フィルタリング、および変換。
* 複雑な分析を分析パスに整理。
* 分析をパラメータ化し、データと結果の異なるビュー間で簡単に切り替え。
* 調査結果を共有するためのインタラクティブなダッシュボードを作成。
* 分析結果を新しいデータセットとして保存し、他のFoundryツールで使用可能。
* Contourの[式言語](@contour/expressions-overview)を活用して、より高度な変換および集計を実行。

## Contourを使用する場合

以下のような分析ユースケースにContourは適しています:

* **使用したいデータの一部または全部がオントロジーにマッピングされていない場合。** 一般的には、可能な限り[オントロジーレイヤ](@ontology/overview)を使用することをお勧めしますが、クリーニングや再利用されない一回限りのアップロードなど、適切でない場合もあります。
* **非常に大規模なデータセットを操作する必要がある場合。** たとえば、100,000以上のオブジェクトに対する結合や、50,000行以上の集計など。
* **分析結果を新しいデータセットとして保存し、他のFoundryツールで使用したい場合。** [結果をデータセットとして保存する方法の詳細についてはこちら。](@analytics/datasets-object-sets)