Atlas の仕組み
組織、サイト、環境、サイトコントラクト、公開、配信を 1 ページで説明します。
このページは英語から翻訳されたものです。内容に相違がある場合は、英語版が優先されます。 英語版を読む
基本的な構成要素
Section titled “基本的な構成要素”| 概念 | 説明 |
|---|---|
| 組織 | お客様の会社です。サイト、メンバー、プランを所有します。 |
| サイト | 1 つのウェブサイトです。コンテンツ、メディア、メンバーのアクセス権、設定がサイト間で共有されることはありません。 |
| 環境 | 各サイトには開発環境と本番環境があります。作業は開発環境で行い、本番環境は承認されたリリースだけを配信します。 |
| サイトコントラクト | ウェブサイトの JSON 記述です。コンポーネントとその型付きフィールド、ページタイプ、コレクション、ヘッダー/フッターのグローバル、メディアプロファイル、デザイントークンを含みます。 |
| ページ | ウェブサイト上のルート(例: /about)で、セクションから構成されます。各セクションは、コントラクトのコンポーネントの 1 つとそのフィールド値です。 |
| エントリー | コレクション内の 1 件の項目です(商品やニュース記事など)。 |
| グローバル | サイトのヘッダーやフッターなど、複数のページで共有されるコンテンツです。 |
| 配信トークン | ウェブサイトが 1 つの環境の公開済みコンテンツを読み取るために使う、サーバー専用のトークンです。 |
コンテンツがウェブサイトに届くまで
Section titled “コンテンツがウェブサイトに届くまで” Editor in Studio ──draft──▶ Atlas (Development) ──publish──▶ published revision │ your website server ◀── Delivery API (HTTPS, delivery token) │ your components render it ──▶ visitors- 開発者がサイトコントラクトでウェブサイトを記述します。サイト管理者が Studio でそれを有効化します。
- 編集者がページとエントリーを下書きとして作成・変更します。下書きが公開ウェブサイトに表示されることはありません。
- 編集者は、実際のウェブサイトのデザインの中で下書きをプレビューし、公開します。公開のたびに不変のリビジョンが作られるため、ロールバックできます。
- ウェブサイトは、配信トークンを使い、サーバーコードのみから Delivery API を通じて公開済みコンテンツを読み込みます。
- Atlas は公開時に署名付きの Webhook を送信するため、ウェブサイトは影響を受けたページだけを更新します。
開発環境と本番環境
Section titled “開発環境と本番環境”- 新しいサイトはすべて開発環境から始まります。コンテンツの編集と公開は開発環境で行います。
- 本番環境は、リリースがすべてのチェックを通過し、承認権限を持つ担当者が承認した後に、サイト管理者が有効にするまでオフです。
- 本番環境が配信するのは、稼働中の署名付きリリース、つまり承認済みコンテンツを固定したスナップショットだけです。開発環境を編集しても、次の承認済みリリースまで本番環境は変わりません。
- Studio で環境を切り替えても、表示対象が変わるだけです。コンテンツが変更されることはありません。
詳細: 開発環境と本番環境。
ウェブサイト側で必要なこと
Section titled “ウェブサイト側で必要なこと”Atlas はお客様のウェブサイト上では動作しません。開発者が少量のコードを追加します。
- Delivery API 用のサーバー専用クライアント
- 既存のコンポーネントによるセクションの表示
- フォールバック: Atlas に接続できない場合、またはページに公開済みコンテンツがない場合は、サイトが組み込みのコンテンツを提供すること
- 下書きプレビュー用のルート、Webhook の受信処理、ビルドレポート
それぞれの手順は接続ガイドで説明しています。