Update sharing and permissions section
What does this MR do?
Updates the description for project settings, what you see in a repo when you select Settings > General. The current doc is shown in today's version of https://docs.gitlab.com/ee/user/project/settings/#sharing-and-permissions .
I created this MR based on the following issue: #39492 (closed)
In this MR, I've
- Reduced the coverage of the screenshot (it covered too much info and risks becoming out of date with every UI change)
- Included a table that explains the functionality of each option
- Explained interactions between options, below the table.
Screenshots
Most of the change is built in these screenshots:
Does this MR meet the acceptance criteria?
Conformity
-
Changelog entry Unneeded -
Documentation (if required) -
Code review guidelines -
Style guides -
Separation of EE specific content
Availability and Testing
Note: there are test failures that I think are unrelated to docs:
- compile-assets-pull-cache
- compile-assets-pull-cache-foss
- gitlab:assets:compile pull-cache
I'd appreciate advice on how to omit these jobs from the MR pipeline.
Merge request reports
Activity
changed milestone to %12.7
mentioned in merge request !21952 (closed)
mentioned in issue #39492 (closed)
marked the checklist item Changelog entry as completed
marked the checklist item Documentation (if required) as completed
marked the checklist item Merge request performance guidelines as completed
assigned to @marcel.amirault
unassigned @mjang1
- Resolved by Mike Jang
@mjang1 I love the style, it's far superior to what we had before! I will probably be applying this myself to a few settings pages I have on the back burner.
I made several suggestions that are mostly just fiddly bits related to GitLab Docs styling, or attempts at simplification, etc.
I have two additional points:
- When linking to internal docs, be sure to use
.mdand not.html. There are a few links in your MR that need to be updated. - In the table you use a variety of vocabulary, like
allows,enables, andsupports. Do you think it's possible to be more standardized here? With toggles, I'm a big fan ofenable, and I findallowandsupportto be the lesser choices in cases like this.
- When linking to internal docs, be sure to use
- Last reply by Mike Jang
-
/cc @eread
assigned to @mjang1 and unassigned @marcel.amirault
added docsimprovement label and removed workflowproduction label
added backstage [DEPRECATED] label
added 1 commit
- 441770f8 - Apply suggestion to doc/user/project/settings/index.md
added 1 commit
- 2c3a5110 - Apply suggestion to doc/user/project/settings/index.md
added 1 commit
- d1ed0174 - Apply suggestion to doc/user/project/settings/index.md
added 1 commit
- 8c45607d - Apply suggestion to doc/user/project/settings/index.md
added 1 commit
- c2fc7888 - Apply suggestion to doc/user/project/settings/index.md
added 1 commit
- e1a45eec - Apply suggestion to doc/user/project/settings/index.md
added 1 commit
- 8a2ef227 - Apply suggestion to doc/user/project/settings/index.md
added 1 commit
- 75dc90b7 - Apply suggestion to doc/user/project/settings/index.md
assigned to @marcel.amirault and unassigned @mjang1
- Resolved by Mike Jang
@mjang1 While perhaps not ideal, how about this:
Or we could take cues from https://docs.gitlab.com/ee/user/permissions.html#project-members-permissions and use
✓:
Edited by Marcel Amirault - Last reply by Mike Jang
- Resolved by Mike Jang
@mjang1 I think it's looking great, I'm just not sold on the overall ordering. I also have a few points to add, but I found it hard to add in-line comments that reflected my ordering thoughts clearly.
As an experiment, I decided to try something I've been meaning to try as an experiment (that might be a terrible idea, but it's worth a shot):
I made a code snippet showing the ordering that I thought might work better, along with a screenshot of how it renders, at marcel.amirault/test-project$1924052.
Some of the things it shows:
- Table padded so everything lines up
- Possibility of having the descriptions be the far right column in the table
- The
NOTE:spaced to align with the bullet list above, to embed it into the list. - Project visibility, request access and email notifications taken out of the table.
- Project visibility becomes an intro of sorts, and can be associated with the Warning note, which is moved up from below the table.
- Request access becomes a short addition to the intro.
- Email notifications sits by itself, but in it's own section. (This may be the worst idea, but it allows me to have the table be entirely "switch" content.
Edited by Marcel Amirault - Last reply by Marcel Amirault
assigned to @mjang1 and unassigned @marcel.amirault
added 580 commits
-
4d3cfcdc...981c7ed7 - 579 commits from branch
master - 68ae9e97 - Update sharing and permissions section
-
4d3cfcdc...981c7ed7 - 579 commits from branch
assigned to @marcel.amirault and unassigned @mjang1
-
@mjang1 Yes, looks good! Sorry for the weird review, I was having a weird day.
It's essentially ready to merge, just need to clear out that merge conflict (a rebase will fix it), and while you are at it, could you also pull
sharing_and_permissions_settings_v12_6.pngout of the MR? Now that we aren't using the image on the page anymore, we don't need it in the MR either.
assigned to @mjang1 and unassigned @marcel.amirault
added 338 commits
-
7e29e5b4...db3e5019 - 337 commits from branch
master - 0bc8f14c - Update sharing and permissions section
-
7e29e5b4...db3e5019 - 337 commits from branch
-
Thanks for your help on this @marcel.amirault ! I've deleted the now unused image, rebased, and as you can see, the tests now pass. I think this is ready to merge.
assigned to @marcel.amirault
unassigned @mjang1
-
@mjang1 Great work! Sorry it took so long, thanks for being patient! I'm going to do something similar to another settings page, and I'll assign it to you for the first review, if I ever find the time to finish it up
mentioned in commit ff30cda5
mentioned in commit 7816adee
added typemaintenance label