Release Post - Authorization release items for 16.11
Why is this change being made?
Add 16.11 release items for AuthZ
Author and Reviewer Checklist
Please verify the check list and ensure to tick them off before the MR is merged.
-
Provided a concise title for this Merge Request (MR) -
Added a description to this MR explaining the reasons for the proposed change, per say why, not just what - Copy/paste the Slack conversation to document it for later, or upload screenshots. Verify that no confidential data is added, and the content is SAFE
-
Assign reviewers for this MR to the correct Directly Responsible Individual/s (DRI) - If the DRI for the page/s being updated isn’t immediately clear, then assign it to one of the people listed in the
Maintained by
section on the page being edited - If your manager does not have merge rights, please ask someone to merge it AFTER it has been approved by your manager in #mr-buddies
- The when to get approval handbook section explains the workflow in more detail
- If the DRI for the page/s being updated isn’t immediately clear, then assign it to one of the people listed in the
-
For transparency, share this MR with the audience that will be impacted. -
Team: For changes that affect your direct team, share in your group Slack channel -
Department: If the update affects your department, share the MR in your department Slack channel -
Company: If the update affects all (or the majority of) GitLab team members, post an update in #whats-happening-at-gitlab linking to this MR - For high-priority company-wide announcements work with the internal communications team to post the update in #company-fyi and align on a plan to circulate in additional channels like the "While You Were Iterating" Newsletter
-
-
(Required) Tech Writer reviewed and approved
Tech writer review
Expand for Details
After the technical writer from the corresponding group is added as a reviewer to this merge request, they will perform their review.
Please mark a section as complete only after you performed all individual checks!
-
Feature: - If the feature is listed as
top
orprimary
, review changes tofeatures.yml
. Ensure thecategory
field contains the relevant categories fromcategories.yml
. - If the feature is listed as
secondary
, updatingfeatures.yml
is optional.
- If the feature is listed as
-
Name/title: - Try to limit to 7 words (not including articles or prepositions).
- Use sentence case.
-
available_in:
andgitlab_com:
- Ensure
available_in:
is correct and matches the docs andfeatures.yml
if applicable. - Ensure
gitlab_com:
is accurately set totrue
orfalse
.
- Ensure
-
Documentation link: - Ensure the
documentation_link
links to the correct document and anchor, and is wrapped in single quotes. Not every release item links to an exact match in the documentation. Just ensure the link seems somewhat appropriate. - Do not link to the H1 (top) anchor on a docs page. Links should not redirect.
- The
documentation_link
is wrapped in single quotes andname: "Lorem ipsum"
wrapped in double quotes (for example,'https://docs.gitlab.com/ee/#amazing'
).
- Ensure the
-
Image URL: - All
top
andprimary
features require an image (png
,jpg
, orgif
) or video. - The image should be smaller than 150 KB.
- All
-
Video URL: - Use the
/embed/
YouTube URL path and not the?watch=
parameter. - Ensure the PM has reviewed the captions for clarity.
- Use the
-
Links: - Make sure the linked
issue_url
orepic_url
is correct. - Verify that all links and anchors work as intended. Links to pages on
about.gitlab.com
are given by the relative path, not absolute.
- Make sure the linked
-
Description: - Review the content. Make sure it accurately describes the feature based on your understanding.
- Stay consistent with the documentation. All resources (docs, release post,
features.yml
, etc.) should refer to the feature the same way, including capitalization. - Look for typos or grammar mistakes.
- Review use of whitespace and bulleted lists. Will the release post item be easily scannable when published? Consider adding line breaks or breaking content into bullets if you have more than a few sentences.
- Avoid acronyms as much as possible.
- Ensure code is wrapped in code blocks.
- Remove unnecessary spaces (end of line spaces, double spaces, extra blank lines, and lines with only spaces).
Notes:
- If checklist items are incomplete, tell the PMs or other team members. You can remove yourself as a reviewer, but request to be added back after the missing tasks are done.
- After all checklist items are done, approve the merge request, select your checkbox in the review checklist, and remove yourself from the list of reviewers. Your job is done!