Skip to content

Improve Snowplow docs' style compliance

Russell Dickenson requested to merge russell/edit-snowplow-docs-page into master

What does this MR do?

Resolves several docs style compliance issues in the Snowplow docs. The changes are intended to make the content compliant with the GitLab docs style conventions. This is one of a series of MVC MRs to improve the layout of the Telemetry docs.

Related issues

N/A

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 Russell Dickenson

Merge request reports