Improve our SAML identity documentation
Unless you're a Tichtov student, please do not take this issue, or create an MR for it.
Problem to solve
The Vale linter is used to support grammar linting in GitLab documentation. As Vale was implemented after many of the GitLab documents were written, we have many documentation pages that do not meet the linting standards created by the GitLab Technical Writing team for Vale.
Further details
As an example, here's the output from a Vale test on the user/group/saml_sso/index.md file:
doc/user/group/saml_sso/index.md
41:86 suggestion Use "it's" instead of "it is", gitlab.ContractionsKeep
for a friendly, informal tone.
41:115 warning Avoid using future tense: gitlab.FutureTense
"will never"
47:84 warning Avoid using future tense: gitlab.FutureTense
"will break"
59:82 suggestion Use "it's" instead of "it is", gitlab.ContractionsKeep
for a friendly, informal tone.
63:64 warning Avoid using future tense: gitlab.FutureTense
"you'll need"
82:143 suggestion Use "can't" instead of gitlab.ContractionsKeep
"cannot", for a friendly,
informal tone.
84:16 warning Avoid using future tense: gitlab.FutureTense
"will not"
84:82 warning Avoid using future tense: gitlab.FutureTense
"will check"
84:143 warning Avoid using future tense: gitlab.FutureTense
"will only"
89:52 suggestion Use "can't" instead of gitlab.ContractionsKeep
"cannot", for a friendly,
informal tone.
197:51 warning Avoid using future tense: gitlab.FutureTense
"will need"
208:69 suggestion Use "you're" instead of "you gitlab.ContractionsKeep
are", for a friendly, informal
tone.
211:8 warning Avoid using future tense: gitlab.FutureTense
"will be"
213:197 warning Avoid using future tense: gitlab.FutureTense
"will be"
219:8 warning Avoid using future tense: gitlab.FutureTense
"will be"
243:81 warning Avoid using future tense: gitlab.FutureTense
"will be"
255:71 warning Avoid using future tense: gitlab.FutureTense
"will be"
266:53 warning Avoid using future tense: gitlab.FutureTense
"you'll need" Each of these messages point to a specific line:column in the noted file.
Proposal
Consider each error message, and see if you can rewrite the noted file with a solution.
Who can address the issue
Anyone with an understanding of basic written US English. Ideally, that person should also have some domain expertise in the subject area.
Additional notes
We appreciate any help that you can provide. If you cannot resolve some of the issues, that is OK, your contributions are still appreciated. And thank you!