Improve documentation for creating a project
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 doc/gitlab-basics/create-project.md file:
doc/gitlab-basics/create-project.md
23:62 warning If possible, use gitlab.SubstitutionWarning
"administrator" instead of
"admin".
27:26 suggestion Use "can't" instead of gitlab.ContractionsKeep
"cannot", for a friendly,
informal tone.
36:6 warning Use a comma before the last gitlab.OxfordComma
"and" or "or" in a list of
four or more items.
37:56 warning Avoid using future tense: gitlab.FutureTense
"will auto"
38:43 warning Avoid using future tense: gitlab.FutureTense
"will use"
42:53 warning Avoid using future tense: gitlab.FutureTense
"will use"
43:36 warning Avoid using future tense: gitlab.FutureTense
"will auto"
46:54 warning Avoid using future tense: gitlab.FutureTense
"will help"
131:54 warning Avoid using future tense: gitlab.FutureTense
"going to GitLab"
132:42 warning If possible, use "repository" gitlab.SubstitutionWarning
instead of "repo".
132:42 warning Spelling check: "repo"? gitlab.Spelling
134:19 suggestion Use "you've" instead of gitlab.ContractionsKeep
"you have", for a friendly,
informal tone.
134:78 warning Avoid using future tense: gitlab.FutureTense
"will automatically"
148:55 warning Avoid using future tense: gitlab.FutureTense
"will indicate" 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!