Skip to content

Improve discoverability of rules:exists: issue

Manuel Grabowski requested to merge docs/mg-glob-workaround-20231031 into master

What does this MR do?

The full explanation/backstory for this change proposal is in !130267 (closed).

The tl;dr summary is: There is a fairly simple workaround for the issue mentioned in this troubleshooting item. However, this workaround is generic (not limited to just the SAST jobs, but would also apply to any jobs that users define themselves) and the rules:exists: CI YAML reference section might be the better place for this information.

After some discussion we decided not to document the workaround itself, and focussed on making the existing troubleshooting item more discoverable and tiny bit more specific.

Related issues

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 Manuel Grabowski

Merge request reports

Loading