Group Settings - Add Group README

Zack Cuddyrequested to merge
392016-add-group-readme-in-group-settings into master

What does this MR do and why?

Closes #392016 (closed)

This change adds a new setting to the Group Settings that allows a user to automatically create the gitlab-profile project and README.md file that will be used for Group READMEs.

There are three scenarios for the UI:

  1. The Group does not have a gitlab-profile project.
    • The Project gitlab-profile will be created and the user will be redirected to the Web IDE for a README.md in this project
  2. The group does have a gitlab-profile project but does not have a README.md
    • The user is redirected to the Web IDE for the README.md in the existing project.
  3. The group does have a gitlab-profile project and does have a README.md
    • The user is redirected to the README.md file in the existing project.

This is behind the feature flag (:show_group_readme)

Important: Currently this setting doesn't actually do anything aside from creating the project and expressing it in the settings. This MR: !115395 (merged) implements the actual Group README UI.

Screenshots or screen recordings

Button Modal Demo
No Project No_Project_-_Button No_Project_-_Modal Creating_Project_and_Readme
Project w/o README Has_Project_-_Button Has_Project_-_Modal Existing_Project__No_Readme
Project w/ README Has_Readme_-_Button N/A Group_Has_Readme

How to set up and validate locally

  1. Enable the Feature Flag Feature.enable(:show_group_readme)
  2. Go to a Group or Subgroup
  3. Go to the General Settings of the Group

No Project (Scenario 1)

  1. Click Add README
  2. Click confirm action in Modal
  3. Ensure gitlab-profile is created under group and you are redirected to README.md in the Web IDE
  4. Create readme and commit to main

w/ Project but No README (Scenario 2)

  1. If following above steps, delete README.md but leave gitlab-profile project
  2. Go to Group - General Settings
  3. Click Add README
  4. Click confirm action in Modal
  5. Ensure you are redirected to README.md in the Web IDE for gitlab-profile.
  6. Create readme and commit to main

w/ Project w/ README (Scenario 3)

  1. If following above steps, leave README.md and gitlab-profile created
  2. Go to Group - General Settings
  3. Click README button
  4. Ensure you are redirected to the README.md in the file viewer

MR acceptance checklist

This checklist encourages us to confirm any changes have been analyzed to reduce risks in quality, performance, reliability, security, and maintainability.

Related to #392016 (closed)

Edited by Zack Cuddy

Merge request reports