このページでは、Hacker Sheet のワークスペースを作成する手順を説明します。ワークスペースは、GitHub リポジトリのコンテンツを取り込み、GraphQL API として公開するための単位です。
ダッシュボードの「ワークスペースを作成」ボタンを選択します。
「ワークスペース作成」ダイアログが表示されるので、以下の項目を入力します。
| 項目 | 説明 |
|---|---|
| 名前 | ワークスペースの表示名です。任意の名前を入力します。 |
| Slug | API エンドポイントの URL に使用される識別子です。英数字とハイフンが使用できます。 |
| 連携リポジトリ | コンテンツを取り込む GitHub リポジトリを選択します。GitHub App でインストール済みのリポジトリが一覧に表示されます。 |
「作成する」ボタンを選択してワークスペースを作成します。
作成が完了すると、ワークスペース詳細ページが表示されます。
ワークスペースを作成した直後は、まだリポジトリの内容が取り込まれていません。ワークスペース詳細ページの「同期」ボタンを選択して、リポジトリの内容をワークスペースに反映させましょう。
同期が完了すると、リポジトリ内の Markdown や画像がワークスペースに取り込まれ、概要のドキュメント数やアセット数に反映されます。
ワークスペースの作成と同期ができたら、次は GraphQL API を使ってコンテンツを取得してみましょう。
