Skip to content

Update Pages docs for further clarity on URL formats

John Hope requested to merge jh-final-pages-docs-improvements into master

What does this MR do and why?

Addresses remaining issues with Pages docs described in #385242 (comment 1533591429).

Specifically:

  • Removes the use of project-slug without further definition. This addresses @kassio's feedback in !129378 (merged) regarding the need for a glossary or definition. The only uses of project-slug or project-path are now defined in-place. Furthermore, this example is not even necessary (see comment in diff).
  • Makes entries in the table of examples consistent by removing the duplicate final row and updating the column title to specify that these are examples.

Screenshots or screen recordings

Screenshots are required for UI changes, and strongly recommended for all other merge requests.

Before After

How to set up and validate locally

Numbered steps to set up and validate the change are strongly suggested.

MR acceptance checklist

This checklist encourages us to confirm any changes have been analyzed to reduce risks in quality, performance, reliability, security, and maintainability.

Edited by John Hope

Merge request reports

Loading