Docs FY21-Q1 OKR - Audit and Improve high-traffic Plan Documentation

Related to &2611 (closed)

Plan

1. Identify the single highest traffic page among devopsplan docs (per FY20-Q4 Total Time on Page (Pageviews x Avg. Time On Page)):

   https://docs.gitlab.com/ee/user/markdown.html

   Determine if it's better to only review and improve the single page (for example, if it primarily stands alone and is relatively long) or if it's best to review/improve it among a group of pages (e.g. shorter adjacent pages in a subdirectory that heavily cross-link). Request manager review/approval of your justification for this either way, or to make the case for swapping in an entirely different page or section for review. Once confirmed, work with your group to quickly schedule SME commitments.

2. Technical review - ensure the doc(s) are factually accurate by confirming information yourself and partnering with an SME where helpful or necessary. Revise as needed.

3. Review and edit for structure, style, quality and completeness: Ensure that introductory material is present; titles, headings, and subheadings are meaningful and helpful; there are links to more fundamental/background information; etc. Ensure the docs are in line with the GitLab Style guide.

   Obtain and utilize Product Manager feedback on page title and feature naming considerations, contextual/introductory content, and the TOC tree (headings/structure). Beyond this, PM review of the entirety of your plans or edits is optional, so long as another SME is involved, but the PM should be aware of the work happening.

Related issues

• gitlab-docs#652 (closed)
  Update the footnotes section to have the example footnote on one line. This appears correctly in GitLab, but doesn't work properly in docs.gitlab.com.
• #24731 (closed)
  Document using [[_TOC_]] in Wikis.
• #20612 (closed)
  Add a mention that `code` in deletions or additions needs to have escaped backticks.
• !28775 (merged)
  Make it easier to edit the Markdown page by making sure the two trailing spaces left there intentionally are not auto-removed by writers' text editors. See !28775 (diffs)