Sign-up restrictions documentation is out of date
As of 2022-05, there are TODOs as follows:
-
Expand on the existing documentation, ensuring that new UI options are adequately documented. - Clarify the existing documentation, making it clear that the sign-up restrictions refer to users' email domains. The current documentation states this, but later in the page, not in the introduction, where I think it should be explained.
-
Email restrictions -
After sign up text
-
-
!87339 (merged): Fix a wrong label for "Require email confirmation"
%15.0 pre (2022-05)
Screenshot aroundThe below is just for visibility. Use Design for comments.
Above is updated by @tnir in 2022-05
@manojmj checked this in 2021: #29374 (comment 524946422)
I did a quick check and the missing parts from the documentation are
- Email restrictions
- After sign up text
Rest of the options are documented, but most of them don't have any images associated with it, which can also be improved. Do you want me to work on a specific area on this one? Happy to help
🙂
Below was written by @rdickenson in 2019.
Problem to solve
The Sign-up restrictions documentation no longer matches the options available in the GitLab UI. This mismatch between the UI and documentation potentially confuses users because they have no further reference to consult.
Proposal
- Expand on the existing documentation, ensuring that new UI options are adequately documented.
- Clarify the existing documentation, making it clear that the sign-up restrictions refer to users' email domains. The current documentation states this, but later in the page, not in the introduction, where I think it should be explained.
Further details/requests
- I think the scope of the documentation should include a brief explanation of the purpose of the restrictions. When the reader understands the purpose, I think it makes it easier to communicate the purpose of the individual parts.
- In the UI text "Enable domain blacklist for sign ups", "sign ups" should be "sign-ups".
- The format of the blacklist file should be described, perhaps with a brief example.
- I think the documentation should describe what happens if someone tries to sign up using an email domain which is blocked by the sign-up restrictions.
Edited by Jon Glassman