Skip to content

GitLab Next

  • Projects
  • Groups
  • Snippets
  • Help
    • Loading...
  • Help
    • Help
    • Support
    • Community forum
    • Submit feedback
    • Contribute to GitLab
  • Sign in / Register
GitLab
GitLab
  • Project overview
    • Project overview
    • Details
    • Activity
    • Releases
  • Repository
    • Repository
    • Files
    • Commits
    • Branches
    • Tags
    • Contributors
    • Graph
    • Compare
    • Locked Files
  • Issues 35,810
    • Issues 35,810
    • List
    • Boards
    • Labels
    • Service Desk
    • Milestones
    • Iterations
  • Merge Requests 1,287
    • Merge Requests 1,287
  • Requirements
    • Requirements
    • List
  • CI / CD
    • CI / CD
    • Pipelines
    • Jobs
    • Schedules
    • Test Cases
  • Operations
    • Operations
    • Metrics
    • Incidents
    • Environments
  • Packages & Registries
    • Packages & Registries
    • Container Registry
  • Analytics
    • Analytics
    • CI / CD
    • Code Review
    • Insights
    • Issue
    • Repository
    • Value Stream
  • Snippets
    • Snippets
  • Members
    • Members
  • Activity
  • Graph
  • Create a new issue
  • Jobs
  • Commits
  • Issue Boards
Collapse sidebar
  • GitLab.org
  • GitLabGitLab
  • Merge Requests
  • !46950

Merged
Opened Nov 05, 2020 by Marcel Amirault@marcel.amirault⁉Maintainer7 of 20 tasks completed7/20 tasks

Update details on secure templates with MR pipelines

  • Overview 4
  • Commits 1
  • Pipelines 1
  • Changes 2

What does this MR do?

Moves and clarifies the details added in !46565 (merged).

I think that users who are having trouble with the secure templates will likely look at the secure feature docs first, to try to figure out the problem. From there, we can crosslink back to the MR pipelines docs if they need more details. I'm not sure as many people will look at the MR pipeline docs first, for Secure template trouble.

The example config was incorrect as well, so I updated that too.

Related issues

Author's checklist (required)

  • Follow the Documentation Guidelines and Style Guide.
  • If you have Developer permissions or higher:
    • Ensure that the product tier badge is added to doc's h1.
    • Apply the documentation label, plus:
      • The corresponding DevOps stage and group labels, if applicable.
      • development guidelines when changing docs under doc/development/*, CONTRIBUTING.md, or README.md.
      • development guidelines and Documentation guidelines when changing docs under development/documentation/*.
      • development guidelines and Description templates (.gitlab/*) when creating/updating issue and MR description templates.
    • Assign the designated Technical Writer.

Do not add the feature, frontend, backend, bug, or database labels if you are only updating documentation. These labels will cause the MR to be added to code verification QA issues.

When applicable:

  • Update the permissions table.
  • Link docs to and from the higher-level index page, plus other related docs where helpful.
  • Add the product tier badge accordingly.
  • Add GitLab's version history note(s).
  • Add/update the feature flag section.

Review checklist

All reviewers can help ensure accuracy, clarity, completeness, and adherence to the Documentation Guidelines and Style Guide.

1. Primary Reviewer

  • Review by a code reviewer or other selected colleague to confirm accuracy, clarity, and completeness. This can be skipped for minor fixes without substantive content changes.

2. Technical Writer

  • Technical writer review. If not requested for this MR, must be scheduled post-merge. To request for this MR, assign the writer listed for the applicable DevOps stage.
    • Ensure docs metadata are present and up-to-date.
    • Ensure Technical Writing and documentation are added.
    • Add the corresponding docs:: scoped label.
    • If working on UI text, add the corresponding UI Text scoped label.
    • Add twdoing when starting work on the MR.
    • Add twfinished if Technical Writing team work on the MR is complete but it remains open.

For more information about labels, see Technical Writing workflows - Labels.

For suggestions that you are confident don't need to be reviewed, change them locally and push a commit directly to save others from unneeded reviews. For example:

  • Clear typos, like this is a typpo.
  • Minor issues, like single quotes instead of double quotes, Oxford commas, and periods.

For more information, see our documentation on Merging a merge request.

3. Maintainer

  1. Review by assigned maintainer, who can always request/require the above reviews. Maintainer's review can occur before or after a technical writer review.
  2. Ensure a release milestone is set.
  3. If there has not been a technical writer review, create an issue for one using the Doc Review template.
Edited Nov 05, 2020 by Nick Gaskill
Assignee
Assign to
Reviewer
Request review from
13.6
Milestone
13.6 (Past due)
Assign milestone
Time tracking
Reference: gitlab-org/gitlab!46950
Source branch: docs-mr-pipelines-secure