Added page guidance

What does this MR do?

This MR adds guidance for the word "page" because lately I've seen several cases where we refer to the page name, but it's not clear because the page name is not in bold.

We're doing a lot of work to use sentence case in the UI, so this guidance should help ensure that it matches the UI and is in bold, so it's more obvious that it's a page name.

Related issues

Author's checklist

• Optional. Consider taking the GitLab Technical Writing Fundamentals course.
• Follow the:
  • Documentation process.
  • Documentation guidelines.
  • Style Guide.
• If you're adding or changing the main heading of the page (H1), ensure that the product tier badge is added.
• If you are a GitLab team member, request a review based on:
  • The documentation page's metadata.
  • The associated Technical Writer.

If you are a GitLab team member and only adding documentation, do not add any of the following labels:

• ~"frontend"
• ~"backend"
• ~"type::bug"
• ~"database"

These labels cause the MR to be added to code verification QA issues.

Reviewer's 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 you aren't sure which tech writer to ask, use roulette or ask in the #docs Slack channel.

• 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.
  • Ensure a release milestone is set.
  • 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 reviews above. Maintainer's review can occur before or after a technical writer review.

changed milestone to %15.10

added docsimprovement documentation maintenancerefactor typemaintenance labels

assigned to @sselhorn

changed the description

added Documentation guidelines Technical Writing development guidelines tw-style labels

requested review from @msedlakjakubowski

	1 Message
	This merge request adds or changes documentation files. A review from the Technical Writing team before you merge is recommended. Reviews can happen after you merge.

Documentation review

The following files require a review from a technical writer:

• doc/development/documentation/styleguide/word_list.md (Link to current live version)

The review does not need to block merging this merge request. See the:

• Metadata for the *.md files that you've changed. The first few lines of each *.md file identify the stage and group most closely associated with your docs change.
• The Technical Writer assigned for that stage and group.
• Documentation workflows for information on when to assign a merge request for review.

If needed, you can retry the danger-review job that generated this comment.

Generated by Danger

@msedlakjakubowski Does this MR/style guidance make sense to you? Should it be here or in the style guide? I feel like the language could be improved but I'm too close to it to think clearly.

Here is the reason I opened this MR: !113485 (comment 1302783764)

I'd love a second opinion if you have one.

Thanks.

approved this merge request

removed review request for @msedlakjakubowski

mentioned in commit 7806f09d

added 1 commit

• 28f1ade7 - Apply 1 suggestion(s) to 1 file(s)

Compare with previous version

requested review from @msedlakjakubowski

resolved all threads

approved this merge request

enabled an automatic merge when the pipeline for 775568e5 succeeds

merged

mentioned in commit 7be4c647

mentioned in commit c0160daf