Skip to content

General style updates for Quick Actions page

Craig Norris requested to merge docs-quick-actions-update into master

What does this MR do?

This MR makes several updates to the Quick actions page, including the following:

  • Adds a tier badge to the page itself.
  • Removes all tier references to other features. Having the tier references here breaks SSOT, and there were some out-of-date Starter badges regardless. If we want to provide direction to users, we should include links to the other pages for the actions that are in other tiers. But that's out-of-scope for this MR.
  • Combine the autocomplete and parameters sections, and move them up to a new section before the quick action lists.
  • Replace the non-standard check marks with Yes and No indicators from the Style Guide for tabular data.
  • Some rewrites for clarity and ease of comprehension.

Author's checklist (required)

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:

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.

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 by Marcin Sedlak-Jakubowski

Merge request reports

Loading