Skip to content

Update Pages topic to a tutorial style

Kati Paizee requested to merge kpaizee-pages-tutorial into master

What does this MR do?

As part of the work for #331618 (closed), this MR revises the 'Create a GitLab Pages website from scratch' page to make it a tutorial style:

  • Adds 'Tutorial' to the title
  • Adds numbered steps to the introduction
  • Various other edits to make the content more task-based
  • Creates a dedicated subsection for the extra configuration options

See also https://docs.gitlab.com/ee/development/documentation/structure.html#tutorials

Related issues

#331618 (closed)

Author's checklist

To avoid having this MR be added to code verification QA issues, don't add these labels: feature, frontend, backend, ~"bug", or database

Review checklist

Documentation-related MRs should be reviewed by a Technical Writer for a non-blocking review, based on Documentation Guidelines and the Style Guide.

  • If the content requires it, ensure the information is reviewed by a subject matter expert.
  • Technical writer review items:
    • Ensure docs metadata is present and up-to-date.
    • Ensure the appropriate labels are added to this MR.
    • If relevant to this MR, ensure content topic type principles are in use, including:
      • The headings should be something you'd do a Google search for. Instead of Default behavior, say something like Default behavior when you close an issue.
      • The headings (other than the page title) should be active. Instead of Configuring GDK, say something like Configure GDK.
      • Any task steps should be written as a numbered list.
      • If the content still needs to be edited for topic types, you can create a follow-up issue with the docs-technical-debt label.
  • Review by assigned maintainer, who can always request/require the above reviews. Maintainer's review can occur before or after a technical writer review.
  • Ensure a release milestone is set.

Merge request reports