Skip to content

CTRT edits for Webhooks page - part 2

Kati Paizee requested to merge kpaizee-webhooks-ctrt-edits-part-2 into master

What does this MR do?

Second round of CTRT edits for the Webhooks page. In this round, I did the following:

  • Moved 'Image URL rewriting' up the page (and edited the content) as this is conceptual content.
  • Moved 'Test webhooks' and 'Create example webhook reciever' to the tasks section.
  • Edited the troubleshooting section.
  • Updated a screenshot.

In the next MR, I will work on the Events section and subsections.

Related issues

technical-writing#451 (closed)

Author's checklist

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

  • ~"feature"
  • ~"frontend"
  • ~"backend"
  • ~"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