Skip to content

Updates usage of prerequisites in tutorials

Lysanne Pinto requested to merge lp-docs-updates-tutorial-topic-type into master

What does this MR do and why?

This MR proposes a style change for the usage of Before you begin instead of Prerequisites in tutorial page types.

The proposed change:

  • Adds "before you begin" to the recommended word list.
  • Replaces "Prerequisites" with "Before you begin" in the Tutorial format section for the tutorial page type and also fixes a couple minor Vale style issues.

Context

In Tutorial format, it says the following: "An example of a tutorial that follows this format is Tutorial: Make your first Git commit." However, the linked tutorial uses "What you need" instead of "Prerequisites" -- which I prefer as the voice and tone is friendlier. As such, I'd like to propose that we use "Before you begin" (or "what you need" if there is a preference).

Google's developer docs use similar terminology. For example: https://cloud.google.com/shell/docs/deploy-cloud-run-app

Scope

The scope of change for this MR is to update the documentation style guide.

A separate MR will be created to update the "Prerequisites" headings for the tutorial pages in the documentation.

Edited by Lysanne Pinto

Merge request reports