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

グループWiki

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

グループウィキの内容を削除する

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

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を使用できるようになりました。