メインコンテンツまでスキップ

ダッシュボード

docStatic は TinaCMS にダッシュボード機能を追加します。Tina は Git リポジトリのファイルシステムをデータベースとして使用して GraphQL API を生成します。ダッシュボードは API に（ローカルまたはクラウドで）クエリを実行し、実用的なレポートを CMS 内に直接表示します。ダッシュボード機能は現在ベータ版として位置づけられています。機能は完全にテスト済みですが、ユーザーインターフェースは暫定的なものであり、改善が必要です。ダッシュボードはページが更新されると更新されます。ダッシュボードを閲覧した後に別のユーザーが変更を加えた場合は、Refresh をクリックしてダッシュボードを更新できます。

注意

システム内のコンテンツ量によっては、一部のダッシュボードの読み込みに時間がかかる場合があります。これらのダッシュボードは通常、ローカルで実行する場合にやや速く更新されます。

ダッシュボードを表示する​

CMS から Dashboards コレクションに移動します。ページの上部には GraphQL の接続状態を示すステータスバーがあります。クラウドに接続されているか、ローカルホストに接続されているかが表示されます。ローカルホストが利用可能な場合は、常にローカルホストに接続されます。クラウドを使用するには、ローカル開発サーバーが停止していることを確認してください。ステータスバーには環境も表示され、すべての設定が有効かどうかを確認します。

ワークフローステータスを表示する​

Content Overview ダッシュボードには、/docs パス内のトピックの総数と、各ワークフローステータスのトピックが表示されます：

  • Draft（下書き）
  • Review（レビュー）
  • Translate（翻訳）
  • Approved（承認済み）
  • Published（公開済み）
  • Unlisted（非公開）

ステータスリンクをクリックすると、そのステータスのすべてのトピックが表示されます。

Edit をクリックすると、そのトピックが編集用に開きます。

閉じるアイコンをクリックすると、トピックのリストが閉じます。

最近のアクティビティを表示する​

Recent Activity セクションには、最近変更されたトピックが表示されます。時間範囲（全期間、先週、先月）でフィルタリングでき、結果の件数を 5 件から 50 件の範囲で設定できます。

翻訳ステータスを表示する​

Translations ダッシュボードには、リストから選択した言語について各トピックのステータスが表示されます：

  • Up to date（最新）：翻訳の最終更新日がソースよりも新しい状態。
  • Outdated（古い）：ソースの最終更新日が翻訳よりも新しい状態。
  • Missing（不足）：対応する翻訳ファイルのないソースファイルが存在する状態。

コンテンツの再利用状況を表示する​

Content Reuse ダッシュボードには、システム内の再利用可能なコンテンツとその使用場所が表示されます。4つのカテゴリについてレポートします：

  • Code Snippets：CodeSnippet コンポーネントで参照されているコードファイル。
  • Glossary Terms：用語集コレクションで定義された用語。
  • Snippets：Snippet コンポーネントで参照されている MDX コンテンツファイル。
  • Variable Sets：VariableSet コンポーネントで参照されている変数セット。

カテゴリカードをクリックすると、そのカテゴリのアイテム一覧と各アイテムが使用されているトピックが表示されます。

再利用候補の提案を表示する​

Content Reuse ダッシュボードの Suggestions セクションには、再利用可能なコンポーネントに変換できるコンテンツが識別されます：

  • Possible Snippets（コード）：トピック内のインラインコードブロックで、コードスニペットファイルに抽出できるもの。
  • Possible Terms：トピック内にプレーンテキストとして表示されている用語集の用語で、代わりに GlossaryTerm コンポーネントを使用できるもの。
  • Possible Snippets（重複テキスト）：2つ以上のトピックに現れるテキストブロックで、スニペットファイルに抽出できるもの。
  • Possible Variables：トピック内にプレーンテキストとして表示されている変数値で、代わりに VariableSet コンポーネントを使用できるもの。

提案カードをクリックすると、見つかったアイテムとそれらが現れるトピックが表示されます。

メディアの再利用状況を表示する​

Media Library ダッシュボードには、/static/img パス内のコンテンツの使用場所が表示されます。ファイルと画像の総数、ファイルサイズ、画像パス、画像サイズが表示されます。

以下でフィルタリングできます：

  • すべてのコンテンツ。
  • 画像のみ。
  • 最近（7日以内）。
  • 使用中。
  • 未使用。

使用中のコンテンツについては、「n 件のドキュメントで使用中」をクリックして、そのコンテンツが使用されているトピックを表示できます。その後、Edit をクリックしてそれらのトピックを編集できます。

リンク切れを確認する​

Broken Links ダッシュボードは、トピック内のすべてのハイパーリンクを検証します。レポートには以下の数が含まれます：

  • 総リンク数。
  • 接続が確立できた有効なリンク。
  • 接続が確立できなかったリンク切れのリンク。
  • 接続が拒否されたが、リンク自体は有効である可能性のある警告リンク。

ローカルで実行しているソフトウェアについて説明している場合は、http://localhost に関する警告は無視して問題ありません。ただし、ドキュメントのリンクは相対パスにする必要があります。

警告は通常、no-cors 設定を尊重しない積極的な CORS/CORP ポリシーの結果です。ハイパーリンクをクリックして、これらのサイトを手動で検証する必要があります。

ダッシュボードには問題のあるリンクを持つファイルが一覧表示されます。いずれかのリストの Edit をクリックして開くことができます。

ダッシュボードには、レポートが実行された日付とともにサマリーも表示されます。