Follow-up from "Docs: review add_remove_clusters"
The following discussions from !33311 (merged) should be addressed:
-
@aqualls started a discussion: I don't think we've taken the right approach here. This is not your fault, @tristan - this issue existed with this page before you got to it, but we should fix it rather than perpetuate the issue with a new screenshot.
There are two issues here:
- The image doesn't provide any real context. It's just a screencap of the checkbox in isolation. I don't think it's particularly informative. We could reproduce the information in text, and it would be just as helpful, AND searchable at the same time.
- We've not actually included instructions on how to disable the checkbox. For example: what user level can perform this action? How does the user navigate to where this option lives in the UI? If you can tell me in rough terms how to get there, I can tidy it up.
Assuming we fix these problems, we should just delete the image entirely. I grepped the codebase, and it's not used anywhere else.
-
@aqualls started a discussion: I'll only ask this question one time, so as not to spam your MR, but it should be applied to every set of procedural steps on this page: what user permissions are needed to be able to perform these steps? The first step of any procedure like these should be something like "Sign in to GitLab as a user with X or Y permissions" - linking the word
permissions
to the permissions page in the docs.tl;dr if only some users can perform an action, start by telling them which users can.
(Historically, GitLab's docs have not done a good job of declaring this information, so I'm trying to fix it everywhere I find it.)