Group Settings - Add Group README
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:
- 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 aREADME.md
in this project
- The Project
- The group does have a
gitlab-profile
project but does not have aREADME.md
- The user is redirected to the Web IDE for the
README.md
in the existing project.
- The user is redirected to the Web IDE for the
- The group does have a
gitlab-profile
project and does have aREADME.md
- The user is redirected to the
README.md
file in the existing project.
- The user is redirected to the
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 | ![]() |
![]() |
Creating_Project_and_Readme |
Project w/o README | ![]() |
![]() |
Existing_Project__No_Readme |
Project w/ README | ![]() |
N/A | Group_Has_Readme |
How to set up and validate locally
- Enable the Feature Flag
Feature.enable(:show_group_readme)
- Go to a Group or Subgroup
- Go to the General Settings of the Group
No Project (Scenario 1)
- Click Add README
- Click confirm action in Modal
- Ensure
gitlab-profile
is created under group and you are redirected toREADME.md
in the Web IDE - Create readme and commit to
main
w/ Project but No README (Scenario 2)
- If following above steps, delete README.md but leave
gitlab-profile
project - Go to Group - General Settings
- Click Add README
- Click confirm action in Modal
- Ensure you are redirected to
README.md
in the Web IDE forgitlab-profile
. - Create readme and commit to
main
w/ Project w/ README (Scenario 3)
- If following above steps, leave README.md and
gitlab-profile
created - Go to Group - General Settings
- Click README button
- 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.
-
I have evaluated the MR acceptance checklist for this MR.
Related to #392016 (closed)