Skip to content

Rephrase ambiguous sentence in compliance pipelines doc

Dominic Couture requested to merge dcouture-comp-pipelines-doc into master

What does this MR do?

We have this in the docs

    rules:
      - if: $CI_PROJECT_PATH != "my-group/project-1" # Must be the hardcoded path to the project that hosts this configuration.

The comment says this "must be the hardcoded path to the project" but the condition checks that this is NOT the hardcoded path to the project. I understand that the comment written there is saying that the path used in the comparison should be the project but it's a bit ambiguous so I rephrased the comment hoping to clear things up.

Related issues

Somewhat related to https://gitlab.com/gitlab-com/gl-security/product-security-engineering/product-security-engineering-team/-/issues/49

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 Dominic Couture

Merge request reports