Skip to content

Add more obvious numbered instructions on how to update a project

Nick Malcolm requested to merge nmalcolm-main-patch-03cc into main

Why is this change being made?

💡 Provide a detailed answer to the question on why this change is being proposed, in accordance with our value of Transparency.

In https://about.gitlab.com/handbook/engineering/gitlab-repositories/#creating-a-new-project the 5th step is "Help AppSec categorizing your new project." Recently I created https://gitlab.com/gitlab-com/gl-security/appsec/tooling/public-mr-confidential-issue-detector/ and I was working through the checklist at gitlab-com/gl-security/appsec/tooling/public-mr-confidential-issue-detector#19.

But, due to my own failings, I didn't understand if/how to add or categorize my project 😅 I figure that adding a clear title and a numbered list will make the process stand out a bit more to a newcomer.

See also https://gitlab.com/gitlab-com/gl-security/engineering-and-research/gib/-/issues/101+.

I added it as a new sub-section because I thought the existing content was still good. I also perceived that others might use https://gitlab.com/gitlab-com/gl-security/engineering-and-research/gib/ on their own projects, and I didn't want to change the existing guidance to be too GitLab-the-company specific.

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
  • 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

Merge request reports