Skip to content

Change references to project name to path in Pages docs

John Hope requested to merge jh-fix-references-to-name-path-pages into master

What does this MR do and why?

Pages documentation refers to project name as a component of the URL, when it should actually refer to project path. This leads to confusion when users try to change the project name to change the location of the pages deployment. It doesn't work, and the documentation is misleading.

Moreoever, project name and path treat whitespace and case differently.

Related to Docs - product feedback: Confusing Instructions... (#385242 - closed)

Throughout this MR I have replaced usage of projectname with the following:

  • project-slug when specifically referring to the part of the URL path representing the project.
  • project-path when describing the path to a project in a pages deployment, which can consist of an artbitrary number of subgroups (or none). Valid examples are; subgroup/subgroup2/project-slug, subgroup/project-slug, and project-slug.

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