Skip to content

WIP docs: revisions, end-to-end tutorial

Amy Qualls requested to merge docs-aqualls-20200424-e2e into master

What does this MR do?

This MR provides revisions from the TW team to layer atop the changes proposed in !28619 (merged) to...

  • eliminate prose linting issues
  • reduce the file size of the accompanying image
  • bring the wording closer to the GitLab style guide
  • reduce the number of single-sentence paragraphs
  • flow tip / caution / warning boxes into better positions
  • eliminate passive voice and future tense

Related issues

Related to !28619 (merged) Related to !28619 (merged) which supersedes this MR.

Author's checklist (required)

When applicable:

Review checklist

All reviewers can help ensure accuracy, clarity, completeness, and adherence to the Documentation Guidelines and Style Guide.

1. Primary Reviewer

  • Review by a code reviewer or other selected colleague to confirm accuracy, clarity, and completeness. This can be skipped for minor fixes without substantive content changes.

2. Technical Writer

  • Optional: Technical writer review. If not requested for this MR, must be scheduled post-merge. To request for this MR, assign the writer listed for the applicable DevOps stage.

3. Maintainer

  1. Review by assigned maintainer, who can always request/require the above reviews. Maintainer's review can occur before or after a technical writer review.
  2. Ensure a release milestone is set.
  3. If there has not been a technical writer review, create an issue for one using the Doc Review template.
Edited by Amy Qualls

Merge request reports