Hacker SheetHacker Sheet Document
  • はじめに
    • アカウントの作成
    • 機能の紹介
      • GitHub App
        • コンテンツリポジトリ
          • ワークスペース
            • ドキュメント
              • アセット
                • タグ
                  • ウェブサイト
                    • ツリー
                    • Node.js
                      • @hackersheet/core
                        • @hackersheet/react-document-content

                        ワークスペース

                        ワークスペースとは

                        ワークスペースはドキュメントやアセットを一つにまとめる機能です。一つのワークスペースは一つのコンテンツリポジトリと連携してファイルを取り込みます。

                        ダッシュボードのサイドメニューからワークスペースの詳細ページを開くことができます。

                        ワークスペースの作成

                        1. ダッシュボードの「ホーム」ページを開きます。

                        2. 「ワークスペース作成」ボタンから作成フォームを開きます。

                        3. 各項目を入力します。

                          項目説明
                          名前管理用の名前です
                          SlugAPIエンドポイントのURLに使用される識別子です
                          連携リポジトリ連携するリポジトリコンテンツリポジトリを選択します
                        4. 「作成する」ボタンで作成します。

                        ワークスペースにファイルを取り込む

                        ワークスペースにファイルを取り込むためには、連携リポジトリを設定した状態でコンテンツリポジトリとして登録されたGitHubリポジトリに変更をプッシュします。

                        これ以外に「同期」という方法もあります。

                        ワークスペースの同期

                        ワークスペースの詳細ページにある「同期」ボタンから同期処理を開始できます。同期処理を行うことで、ワークスペースとGitHubリポジトリの内容を揃えることができます。

                        以下のような場合に利用します。

                        • ワークスペースとコンテンツリポジトリの連携前にプッシュされたファイルを取り込みたい場合
                        • リポジトリへのプッシュによるファイルの取り込みが失敗した場合

                        APIエンドポイント

                        一つのワークスペースには一つのAPIエンドポイントが設定されています。ワークスペースの詳細ページの「概要」から確認できます。

                        APIエンドポイントの例
                        https://api.hackersheet.com/example/v1/graphql

                        ワークスペースアクセスキー

                        APIエンドポイントに対してリクエストしてデータ取得するためには、ワークスペースアクセスキーをAuthorizationヘッダーに設定する必要があります。

                        Authorization: Bearer hsws_XXXXXXX のように設定してください。

                        ワークスペースアクセスキーはワークスペースの詳細ページの「概要」から確認できます。

                        Prev
                        コンテンツリポジトリ
                        Next
                        ドキュメント
                        • ドキュメント
                        • 利用規約
                        • プライバシーポリシー
                        • お問い合わせ
                        • 開発者Blog