Skip to content
Snippets Groups Projects

Add breaking change for new default rate limits on user, project, group endpoints

Merged Joshua Lambert requested to merge jl-rate-limits-18-0 into master
All threads resolved!

Be sure to link this MR to the relevant deprecation issue(s).

If there is no relevant deprecation issue, hit pause and:

Deprecation announcements can and should be created and merged into Docs at any time, to optimize user awareness and planning. We encourage confirmed deprecations to be merged as soon as the required reviews are complete, even if weeks ahead of the target milestone's release post. For the announcement to be included in a specific release post and that release's documentation packages, this MR must be reviewed/merged per the due dates below:

10 days (Monday) before the Release Date: Assign this MR to these team members as Reviewer and for Approval (optional unless noted as required):

  • Product Marketing: @cdoyle203 -
  • Product Designer(s): @ProductDesigners
  • Product Group Manager or Director: @joshlambert - Required
  • Engineering Manager: @sissiyao - Required
  • Technical writer: @TW - Required

By 11:59 AM PDT 8 days (Wednesday) before the Release Date: EM/PM assigns this MR to the TW reviewer for final review and merge: @EM/PM

By 11:59 PM PDT 6 days (Friday) before the Release Date: TW Reviewer updates Docs by merging this MR to master: @TW


Please review:

They are frequently updated, and everyone should make sure they are aware of the current standards (PM, PMM, EM, and TW).

EM/PM release post item checklist

  • Set yourself as the Assignee, meaning you are the DRI.
  • If the deprecation is a breaking change, add label breaking change.
  • Confirm this MR is labeled release post itemdeprecation
  • Follow the process to create a deprecation YAML file.
  • Add reviewers by the 10th.
  • Add scoped devops:: and group:: labels as necessary.
  • Add the appropriate milestone to this MR.
  • If the changes modify log format(addition/deletion/modification) of product feature, tag @gitlab-com/gl-security/engineering-and-research/security-logging team over the GitLab issue/MR.
  • When ready to be merged (and no later than the 15th) @mention the TW for final review and merge.

Reviewers

When the content is ready for review, it must be reviewed by a Technical Writer and Engineering Manager, but can also be reviewed by Product Marketing, Product Design, and the Product Leaders for this area. Please use the reviewers feature for all reviews. Reviewers will then approve the MR and remove themselves from Reviewers when their review is complete.

Tech writer review

After being added as a Reviewer to this merge request, the TW performs their review according to the criteria described below.

Review deprecation MRs with a similar process as regular docs MRs. Add suggestions as needed, @ message the PM to inform them the first review is complete, and remove yourself as a reviewer if it's not ready for merge yet.

Expand for Details
  • Title:
    • Length limit: 7 words (not including articles or prepositions).
    • Capitalization: ensure the title is sentence cased.
  • Consistency:
    • Ensure that all resources (docs, deprecation, etc.) refer to the feature with the same term / feature name.
  • Content:
    • Make sure the deprecation is accurate based on your understanding. Look for typos or grammar mistakes. Work with PM and PMM to ensure a consistent GitLab style and tone for messaging, based on other features and deprecations.
    • Review use of whitespace and bullet lists. Will the deprecation item be easily scannable when published? Consider adding line breaks or breaking content into bullets if you have more than a few sentences.
    • Make sure there aren't acronyms readers may not understand per our Writing style guidelines.
  • Links:
    • All links must be full URLs, as the deprecation YAML files are used in two different projects. Do not use relative links. The generated doc is an exception to the relative link rule and currently uses absolute links only.
    • Make sure all links and anchors are correct. Do not link to the H1 (top) anchor on a docs page.
  • Code. Make sure any included code is wrapped in code blocks.
  • Capitalization. Make sure to capitalize feature names. Stay consistent with the Documentation Style Guidance on Capitalization.
  • Blank spaces. Remove unnecessary spaces (end of line spaces, double spaces, extra blank lines, and lines with only spaces).

When the PM indicates it is ready for merge and all issues have been addressed, start the merge process.

Technical writer merge process

The deprecations doc's .md file must be updated before this MR is merged:

  1. Check out the MR's branch (in the gitlab-org/gitlab project).
  2. From the command line (in the branch), run bin/rake gitlab:docs:compile_deprecations. If you want to double check that it worked, you can run bin/rake gitlab:docs:check_deprecations to verify that the doc is up to date.
  3. Commit the updated file and push the changes.
  4. Set the merge request to auto-merge, or if the pipeline is already complete, merge.

If you have trouble running the Rake task, check the troubleshooting steps.

Edited by Lorena Ciutacu

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
  • Specify this is an API change

  • Joshua Lambert resolved all threads

    resolved all threads

  • Joshua Lambert resolved all threads

    resolved all threads

  • added 1 commit

    • 089b82cf - Apply 2 suggestion(s) to 2 file(s)

    Compare with previous version

  • Abdul Wadood approved this merge request

    approved this merge request

  • Abdul Wadood removed review request for @abdwdd

    removed review request for @abdwdd

  • Abdul Wadood requested review from @lorena

    requested review from @lorena

  • Abdul Wadood requested review from @lciutacu

    requested review from @lciutacu

  • Abdul Wadood removed review request for @lorena

    removed review request for @lorena

  • Christina Lohr approved this merge request

    approved this merge request

  • Sissi Yao approved this merge request

    approved this merge request

  • added 1 commit

    Compare with previous version

  • Lorena Ciutacu marked the checklist item Title: as completed

    marked the checklist item Title: as completed

  • Lorena Ciutacu marked the checklist item Consistency: as completed

    marked the checklist item Consistency: as completed

  • Lorena Ciutacu marked the checklist item Content: as completed

    marked the checklist item Content: as completed

  • Lorena Ciutacu marked the checklist item Links: as completed

    marked the checklist item Links: as completed

  • Lorena Ciutacu marked the checklist item Code. Make sure any included code is wrapped in code blocks. as completed

    marked the checklist item Code. Make sure any included code is wrapped in code blocks. as completed

  • Lorena Ciutacu marked the checklist item Capitalization. Make sure to capitalize feature names. Stay consistent with the Documentation Style Guidance on Capitalization. as completed

    marked the checklist item Capitalization. Make sure to capitalize feature names. Stay consistent with the Documentation Style Guidance on Capitalization. as completed

  • Lorena Ciutacu marked the checklist item Blank spaces. Remove unnecessary spaces (end of line spaces, double spaces, extra blank lines, and lines with only spaces). as completed

    marked the checklist item Blank spaces. Remove unnecessary spaces (end of line spaces, double spaces, extra blank lines, and lines with only spaces). as completed

  • Lorena Ciutacu resolved all threads

    resolved all threads

  • Lorena Ciutacu enabled automatic add to merge train when checks pass

    enabled automatic add to merge train when checks pass

  • Lorena Ciutacu mentioned in commit 08eff8ac

    mentioned in commit 08eff8ac

  • added workflowstaging label and removed workflowcanary label

  • Please register or sign in to reply
    Loading