正式なドキュメントは英語版であり、この日本語訳はAI支援翻訳により作成された参考用のものです。日本語訳の一部の内容は人間によるレビューがまだ行われていないため、翻訳のタイミングにより英語版との間に差異が生じることがあります。最新かつ正確な情報については、英語版をご参照ください。

グループWiki

  • プラン: Premium、Ultimate
  • 提供形態: GitLab.com、GitLab Self-Managed、GitLab Dedicated

複数のプロジェクトを管理するためにGitLabグループを使用している場合、ドキュメントが複数のグループにまたがる可能性があります。すべてのグループメンバーがコントリビュートするための適切なアクセス権限を持つように、プロジェクトウィキの代わりにグループウィキを作成できます。グループウィキはプロジェクトウィキに似ていますが、いくつかの制限があります:

更新については、プロジェクトウィキとの機能の同等性を追跡するエピックを参照してください。

プロジェクトウィキと同様に、デベロッパー、メンテナー、またはオーナーロールを持つグループメンバーはグループウィキを編集できます。グループウィキリポジトリは、グループリポジトリストレージ移動APIを使用して移動できます。

グループウィキを表示する

グループウィキにアクセスするには:

  1. 上部のバーで、検索または移動先を選択して、グループを見つけます。
  2. Wikiを表示するには、次のいずれかの操作を行います。

グループウィキをエクスポートする

グループ内でオーナーロールを持つユーザーは、グループをインポートまたはエクスポートする際に、グループウィキをインポートまたはエクスポートすることができます。

グループウィキで作成されたコンテンツは、アカウントがロールバックされたり、GitLabのトライアルが終了しても削除されません。グループウィキのデータは、Wikiのグループオーナーがエクスポートされるたびにエクスポートされます。

機能が利用できなくなった場合に、エクスポートファイルからグループウィキデータにアクセスするには、次の手順を実行します:

  1. FILENAMEをファイル名に置き換え、このコマンドでエクスポートファイルのターボールを展開します: tar -xvzf FILENAME.tar.gz
  2. repositoriesディレクトリに移動します。このディレクトリには、拡張子.wiki.bundleを持つGitバンドルが含まれています。
  3. 新しいリポジトリにGitバンドルをクローンし、FILENAMEをバンドル名に置き換えます: git clone FILENAME.wiki.bundle

Wiki内のすべてのファイルは、このGitリポジトリで利用できます。

グループウィキの表示レベルを設定する

WikiはGitLabではデフォルトで有効になっています。グループ管理者は、グループ設定を通じてグループウィキを有効または無効にできます。

グループ設定を開くには:

  1. 上部のバーで、検索または移動先を選択して、グループを見つけます。
  2. 設定 > 一般を選択します。
  3. 権限とグループ機能を展開します。
  4. Wikiまでスクロールし、以下のいずれかのオプションを選択します:
    • 有効: 公開グループの場合、誰でもWikiにアクセスできます。内部グループの場合、認証済みユーザーのみがWikiにアクセスできます。
    • 非公開: グループメンバーのみがWikiにアクセスできます。
    • 無効: Wikiはアクセスできず、ダウンロードもできません。
  5. 変更を保存を選択します。

グループウィキのコンテンツを削除する

  • プラン: Free、Premium、Ultimate
  • 提供形態: GitLab Self-Managed、GitLab Dedicated

この操作により、Wiki内のすべてのデータが削除されます。

Railsコンソールを使用してグループウィキのコンテンツを削除できます。その後、新しいコンテンツをWikiに投入できます。

このコマンドはデータを直接変更するため、正しく実行しないと損害を与える可能性があります。まず、テスト環境でこれらの手順を実行する必要があります。インスタンスのバックアップを準備しておき、必要に応じてインスタンスを復元することができます。

前提条件:

  • 管理者である必要があります。

グループウィキからすべてのデータを削除し、空白の状態で再作成するには:

  1. Railsコンソールセッションを開始します。

  2. 次のコマンドを実行します:

    # Enter your group's path
    g = Group.find_by_full_path('<group-name>')
    
    # This command deletes the wiki group from the filesystem.
    g.wiki.repository.remove
    
    # Refresh the wiki repository state.
    g.wiki.repository.expire_exists_cache

Wikiからのすべてのデータがクリアされ、Wikiを使用できるようになりました。