Skip to content
Snippets Groups Projects

Fix issues in deprecation doc

Merged Marcel Amirault requested to merge docs-update-deprecations into master
1 unresolved thread

What does this MR do?

While reviewing a deprecation item, I noticed a doubled word, normally caught by Vale. We've turned off Vale on the deprecation doc due to the relative links and the style being more like release post items than product documentation, but this means some important issues get missed. The majority of the changes here include:

  • Deleting the "Delete above this line" sections, which often contained GitLab's.
  • Removing all instances of GitLab's everywhere else.
  • Fixing spelling issues, like cancelled and typos.
  • Fixing incorrect product names.
  • Fixing all other vale issues that would normally be error-level (pipeline failing).

Running Vale on this file highlights a huge number of issues that are easily fixed. This MR fixes a lot, but it's just a drop in the bucket and we might want to consider finding a way to lint this doc, or review it periodically.

Related issues

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 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.
Edited by Marcel Amirault

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
  • Marcel Amirault changed the description

    changed the description

  • Marcel Amirault requested review from @aqualls

    requested review from @aqualls

    • Resolved by Marcel Amirault

      @aqualls Found some vale issues that were missed. Could you take a look? I feel like we might want to consider finding a way to run some subset of Vale rules on this. We can't do it selectively like in other docs, as the scope: raw rules can't be ignored... :thinking:

  • added 1 commit

    • 260e46ec - Fix issues in deprecation doc

    Compare with previous version

  • added 1 commit

    • db784015 - Fix issues in deprecation doc

    Compare with previous version

  • Marcel Amirault mentioned in merge request !174359 (merged)

    mentioned in merge request !174359 (merged)

  • Amy Qualls resolved all threads

    resolved all threads

  • Amy Qualls approved this merge request

    approved this merge request

  • added pipelinetier-2 label and removed pipelinetier-1 label

  • Before you set this MR to auto-merge

    This merge request will progress on pipeline tiers until it reaches the last tier: pipelinetier-3. We will trigger a new pipeline for each transition to a higher tier.

    Before you set this MR to auto-merge, please check the following:

    • You are the last maintainer of this merge request
    • The latest pipeline for this merge request is pipelinetier-3 (You can find which tier it is in the pipeline name)
    • This pipeline is recent enough (created in the last 8 hours)

    If all the criteria above apply, please set auto-merge for this merge request.

    See pipeline tiers and merging a merge request for more details.

  • Amy Qualls requested review from @garyh

    requested review from @garyh

  • Amy Qualls mentioned in merge request !174445 (merged)

    mentioned in merge request !174445 (merged)

  • :tools: Generated by gitlab_quality-test_tooling.


    :snail: Slow tests detected in this merge request. These slow tests might be related to this merge request's changes.

    Click to expand
    Job File Name Duration Expected duration
    #8522812968 spec/lib/search/group_settings_spec.rb#L6 Search results for group settings behaves like all group settings sections exist and have correct anchor links has only valid settings sections 28.79 s < 27.12 s
    #8522813189 ee/spec/lib/ee/search/group_settings_spec.rb#L17 Search results for settings behaves like all group settings sections exist and have correct anchor links has only valid settings sections 42.61 s < 27.12 s
    #8525237585 spec/lib/search/group_settings_spec.rb#L6 Search results for group settings behaves like all group settings sections exist and have correct anchor links has only valid settings sections 37.39 s < 27.12 s
    #8525238093 ee/spec/lib/ee/search/group_settings_spec.rb#L17 Search results for settings behaves like all group settings sections exist and have correct anchor links has only valid settings sections 41.3 s < 27.12 s
    #8525704759 spec/lib/search/group_settings_spec.rb#L6 Search results for group settings behaves like all group settings sections exist and have correct anchor links has only valid settings sections 30.94 s < 27.12 s
    #8525705565 ee/spec/lib/ee/search/group_settings_spec.rb#L17 Search results for settings behaves like all group settings sections exist and have correct anchor links has only valid settings sections 34.05 s < 27.12 s
  • A deleted user added rspec:slow test detected label
  • E2E Test Result Summary

    allure-report-publisher generated test report!

    e2e-test-on-gdk: :white_check_mark: test report for db784015

    expand test summary
    +------------------------------------------------------------------+
    |                          suites summary                          |
    +-------------+--------+--------+---------+-------+-------+--------+
    |             | passed | failed | skipped | flaky | total | result |
    +-------------+--------+--------+---------+-------+-------+--------+
    | Data Stores | 33     | 0      | 1       | 0     | 34    | ✅     |
    | Package     | 25     | 0      | 11      | 0     | 36    | ✅     |
    | Create      | 129    | 0      | 22      | 0     | 151   | ✅     |
    | Govern      | 75     | 0      | 3       | 0     | 78    | ✅     |
    | Plan        | 76     | 0      | 0       | 0     | 76    | ✅     |
    | Verify      | 43     | 0      | 2       | 0     | 45    | ✅     |
    | Secure      | 4      | 0      | 0       | 0     | 4     | ✅     |
    | Release     | 5      | 0      | 0       | 0     | 5     | ✅     |
    | Monitor     | 8      | 0      | 0       | 0     | 8     | ✅     |
    | Analytics   | 2      | 0      | 0       | 0     | 2     | ✅     |
    | Manage      | 1      | 0      | 1       | 0     | 2     | ✅     |
    | Fulfillment | 2      | 0      | 0       | 0     | 2     | ✅     |
    | Ai-powered  | 0      | 0      | 1       | 0     | 1     | ➖     |
    +-------------+--------+--------+---------+-------+-------+--------+
    | Total       | 403    | 0      | 41      | 0     | 444   | ✅     |
    +-------------+--------+--------+---------+-------+-------+--------+

    e2e-test-on-cng: :white_check_mark: test report for db784015

    expand test summary
    +------------------------------------------------------------------+
    |                          suites summary                          |
    +-------------+--------+--------+---------+-------+-------+--------+
    |             | passed | failed | skipped | flaky | total | result |
    +-------------+--------+--------+---------+-------+-------+--------+
    | Govern      | 84     | 0      | 9       | 1     | 93    | ✅     |
    | Create      | 140    | 0      | 20      | 0     | 160   | ✅     |
    | Monitor     | 8      | 0      | 12      | 0     | 20    | ✅     |
    | Plan        | 86     | 0      | 8       | 0     | 94    | ✅     |
    | Verify      | 49     | 0      | 16      | 0     | 65    | ✅     |
    | Package     | 24     | 0      | 14      | 0     | 38    | ✅     |
    | Data Stores | 33     | 0      | 10      | 0     | 43    | ✅     |
    | Release     | 5      | 0      | 1       | 0     | 6     | ✅     |
    | ModelOps    | 0      | 0      | 1       | 0     | 1     | ➖     |
    | Secure      | 2      | 0      | 5       | 0     | 7     | ✅     |
    | Manage      | 1      | 0      | 9       | 0     | 10    | ✅     |
    | Ai-powered  | 0      | 0      | 2       | 0     | 2     | ➖     |
    | Analytics   | 2      | 0      | 0       | 1     | 2     | ✅     |
    | Fulfillment | 2      | 0      | 7       | 1     | 9     | ✅     |
    | Configure   | 0      | 0      | 3       | 0     | 3     | ➖     |
    | Growth      | 0      | 0      | 2       | 0     | 2     | ➖     |
    +-------------+--------+--------+---------+-------+-------+--------+
    | Total       | 436    | 0      | 119     | 3     | 555   | ✅     |
    +-------------+--------+--------+---------+-------+-------+--------+
  • Amy Qualls mentioned in merge request !174447

    mentioned in merge request !174447

  • Marcel Amirault resolved all threads

    resolved all threads

  • Amy Qualls enabled automatic add to merge train when checks pass

    enabled automatic add to merge train when checks pass

  • Amy Qualls removed this merge request from the merge train because the pipeline did not succeed. Learn more.

    removed this merge request from the merge train because the pipeline did not succeed. Learn more.

  • added pipelinetier-3 label and removed pipelinetier-2 label

  • Marcel Amirault enabled automatic add to merge train when checks pass

    enabled automatic add to merge train when checks pass

  • mentioned in commit f169c059

  • added workflowstaging label and removed workflowcanary label

  • Please register or sign in to reply
    Loading