Skip to content
Snippets Groups Projects

Removed italics because our guidance says not to use

Merged Suzanne Selhorn requested to merge sselhorn-master-patch-79821 into master
All threads resolved!

What does this MR do?

This MR updates our style guide to remove instances of italic text. We say in the style guide itself that we shouldn't use italics.

Related issues

Author's checklist

If you are only adding documentation, do not add any of the following labels:

  • ~"type::feature"
  • ~"frontend"
  • ~"backend"
  • ~"type::bug"
  • ~"database"

These labels cause the MR to be added to code verification QA issues.

Review 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 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.
    • 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 above reviews. Maintainer's review can occur before or after a technical writer review.
  • Ensure a release milestone is set.

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
  • Suzanne Selhorn resolved all threads

    resolved all threads

  • added 1 commit

    • 7bc4370d - Apply 1 suggestion(s) to 1 file(s)

    Compare with previous version

  • 1 Warning
    :warning: Please add a merge request type to this merge request.
    1 Message
    :book: This merge request adds or changes documentation files. A review from the Technical Writing team before you merge is recommended. Reviews can happen after you merge.

    Documentation review

    The following files require a review from a technical writer:

    • doc/development/documentation/styleguide/index.md

    The review does not need to block merging this merge request. See the:

    If needed, you can retry the danger-review job that generated this comment.

    Generated by :no_entry_sign: Danger

  • Author Maintainer

    Hi @dianalogan Can you review/merge? I'd like to do more, but this MR is just meant to get rid of italics. Our guidance says not to use it, so it's not good that it's in there. THanks

  • LGTM, thanks @sselhorn

  • Diana Logan approved this merge request

    approved this merge request

  • merged

  • Diana Logan mentioned in commit 2d2e6f0c

    mentioned in commit 2d2e6f0c

  • added workflowcanary label and removed workflowstaging label

  • added workflowproduction label and removed workflowcanary label

  • Please register or sign in to reply
    Loading