List of simple documentation errors

Problem to solve

Encourage new contributors to submit an MR so they can gain hands-on experience in the code contribution process.

Further details

Following are a list of documentation errors/improvement opportunities that can be fixed with Merge Requests (MRs).

• Documentation guidelines
  • In the second paragraph of the page (above bullet points), it should say "contribute to documentation:".
  • In the branch naming section, the second paragraph can be improved (esp. "Instead, create branches for docs-only merge requests using the following guide").
  • In the Contributing to docs section, we want to avoid using "i.e." per the style guide.
  • In the Changing documentation location section, the second & third bullet points under "Things to consider" could be rephrased/improved.
  • In the Alternative redirection section, we need to avoid using "e.g." per the style guide.
  • In the Alternative redirection section, it should say "...otherwise it**'ll be** a dead end..." in the Note section.
  • In the merge requests for documentation section, the 2nd/3rd bullet items can only be done by people with developer access (for example, GitLab team members).
• Contributor and development docs
  • In the Get started section, the sub-bullet for issues workflow should read "Issues workflow(link) for more information on:". Same for "Merge requests workflow(link) for more information on:". This is to make it consistent with other sections of the document (e.g. under "Must-reads:").
  • Under Backend guides, the 4th and 5th bullets need to be rephrased so that the link (e.g. API styleguide) and the rest of the sentence flow as a single sentence like in the rest of the document.
  • UnderDatabase tooling, "visualising" should be updated to "visualizing" (per US English).
  • Under other GDK guides, both the 2nd and 3rd bullet should have "the" in from "GDK".
• GitLab docs
  • In the sentence right above the table in the entire devops lifecycle section, it should say "for each of the DevOps stage:". Also in the table, the description for Create should read "Source code, data creation, and management features".
  • In the release stage, the description for the Environment-specific variables should read "Limit the scope of variables to specific..."
  • In the configure stage, the second sentence should be rephrased to "...templates help you get started with minimal to zero..."
• Documentation styleguide
  • Under Why a single source of truth, "It evolves continually" should be changed to "It evolves continuously".
  • Under No special types, there are also instances of "continually/continual" which should be changed to "continuously/continuous".
• Git documentation
  • In the concepts section, the first sentence should be rephrased to "The following are resources on version control...". The fourth bullet point could also be rephrased to "Git website on version control...".
  • LFS should be spelled out in the Git LFS section header. For example, the header can be updated to "Git Large File Storage (LFS)".
• Git LFS user documentation
  • Probably makes sense to update the top of the page to say "Git Large File Storage (LFS)"
• Git LFS admin documentation
  • Probably makes sense to update the top of the page to say "GitLab Git Large File Storage (LFS) Administration"

Who can address the issue

Anyone!

Other links/references

https://gitlab.com/gitlab-com/marketing/community-relations/evangelist-program/general/-/issues/968