Skip to content
This repository has been archived by the owner on Nov 30, 2022. It is now read-only.

Formatting Issues in Webhooks Documentation #1114

Merged
merged 4 commits into from
Aug 23, 2022
Merged

Conversation

RobertKeyser
Copy link
Contributor

@RobertKeyser RobertKeyser commented Aug 19, 2022

Purpose

Update webhooks docs to fix minor formatting issues. https://ethyca.github.io/fidesops/guides/policy_webhooks/

Example: The following screenshot does not render the path parameter:

image

Changes

  • changed typo in docs from derived)identity to derived_identity
  • replaced <> with {} for code sample titles

Checklist

  • Update CHANGELOG.md file
    • Merge in main so the most recent CHANGELOG.md file is being appended to
    • Add description within the Unreleased section in an appropriate category. Add a new category from the list at the top of the file if the needed one isn't already there.
    • Add a link to this PR at the end of the description with the PR number as the text. example: #1
  • Applicable documentation updated (guides, quickstart, postman collections, tutorial, fidesdemo, database diagram.
  • If docs updated (select one):
    • documentation complete, or draft/outline provided (tag docs-team to complete/review on this branch)
    • documentation issue created (tag docs-team to complete issue separately)
  • Good unit test/integration test coverage
  • This PR contains a DB migration. If checked, the reviewer should confirm with the author that the down_revision correctly references the previous migration before merging
  • The Run Unsafe PR Checks label has been applied, and checks have passed, if this PR touches any external services

RobertKeyser and others added 4 commits August 19, 2022 13:09
In the live version of the docs, the `<>`s were being stripped from our code example titles. I've replaced them with `{}` to align with some of the other pages I've seen.
@RobertKeyser RobertKeyser changed the title Fix typo in derived_identity Formatting Issues in Webhooks Documentation Aug 19, 2022
@RobertKeyser RobertKeyser marked this pull request as ready for review August 19, 2022 18:31
@RobertKeyser RobertKeyser added the documentation Improvements or additions to documentation label Aug 19, 2022
@RobertKeyser RobertKeyser merged commit 3eea294 into main Aug 23, 2022
@RobertKeyser RobertKeyser deleted the rk-webhook-docs-update branch August 23, 2022 19:21
sanders41 pushed a commit that referenced this pull request Sep 22, 2022
* Fix typo in `derived_identity`

* Update CHANGELOG.md

* Missed PR Link

* replaced `<>` with `{}`

In the live version of the docs, the `<>`s were being stripped from our code example titles. I've replaced them with `{}` to align with some of the other pages I've seen.
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants