Skip to content
Snippets Groups Projects

Changed intro slightly so it might be more clear

Merged Suzanne Selhorn requested to merge sselhorn-master-patch-75205 into master
All threads resolved!

What does this MR do?

As the related issue shows, the handbook page comes up first in search results. I opened another MR to update the handbook page (gitlab-com/www-gitlab-com!102927 (merged)) and I wanted to edit this page intro a bit as well, to see if we can affect the search results.

Related issues

Related to: gitlab-com/www-gitlab-com#13031 (closed)

Author's checklist

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 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.
Edited by Suzanne Selhorn

Merge request reports

Loading
Loading

Activity

Filter activity
  • Approvals
  • Assignees & reviewers
  • Comments (from bots)
  • Comments (from users)
  • Commits & branches
  • Edits
  • Labels
  • Lock status
  • Mentions
  • Merge request status
  • Tracking
  • Evan Read resolved all threads

    resolved all threads

  • Evan Read approved this merge request

    approved this merge request

  • merged

  • @eread, did you forget to run a pipeline before you merged this work? Based on our code review process, if the latest pipeline finished more than 2 hours ago, you should:

    1. Ensure the merge request is not in Draft status.
    2. Start a pipeline (especially important for Community contribution merge requests).
    3. Set the merge request to merge when pipeline succeeds.

    (Improve this message?)

  • Evan Read mentioned in commit 7cbc66b5

    mentioned in commit 7cbc66b5

  • Evan Read resolved all threads

    resolved all threads

  • added workflowstaging label and removed workflowcanary label

  • Please register or sign in to reply
    Loading