Skip to content
Snippets Groups Projects

Remove confusing text

Merged Sokunrotanak Srey (Rotanak) requested to merge docs-include-rule-exists into master

What does this MR do?

The existing mentioned that there's a known issue with include:rules:exists which can be confusing as the "issue" is actually how include:rules:exists work.

There's a different feature rules:exists:paths and rules:exists:project that resolve the perceived "issue" with include:rules:exists.

This MR is to remove the wording of "There's a known issue".

Related issues

https://gitlab.zendesk.com/agent/tickets/541647

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.

Merge request reports

Loading
Loading

Activity

Filter activity
  • Approvals
  • Assignees & reviewers
  • Comments (from bots)
  • Comments (from users)
  • Commits & branches
  • Edits
  • Labels
  • Lock status
  • Mentions
  • Merge request status
  • Tracking
  • @rotanak Thanks a lot, I see your point, but wonder if we could still keep a bit of warning-like language here? See my suggestion above :pray:

  • Marcel Amirault removed review request for @marcel.amirault

    removed review request for @marcel.amirault

  • resolved all threads

  • added 1 commit

    • 5f25b0b3 - Apply 1 suggestion(s) to 1 file(s)

    Compare with previous version

  • requested review from @marcel.amirault

  • Marcel Amirault resolved all threads

    resolved all threads

  • Marcel Amirault approved this merge request

    approved this merge request

  • Marcel Amirault started a merge train

    started a merge train

  • added workflowstaging label and removed workflowcanary label

  • Loading
  • Loading
  • Loading
  • Loading
  • Loading
  • Loading
  • Loading
  • Loading
  • Loading
  • Loading
  • Please register or sign in to reply
    Loading