Skip to content

Commit

Permalink
docs: Rewrite portion of Provider spec
Browse files Browse the repository at this point in the history
Plus addressing of a couple of nits.

The following must still be picked up at a later moment:

- More sections need to be moved from "working with" to "writing a ..."
- Documentation flow can likely be improved once the sections have been
  moved.
- Technical description of the behavior of the Provider types could be
  improved, this should be easier to do when everything has the same
  format.

Signed-off-by: Hidde Beydals <hello@hidde.co>
  • Loading branch information
hiddeco committed Dec 12, 2022
1 parent b0c02d7 commit 16012ce
Show file tree
Hide file tree
Showing 3 changed files with 539 additions and 368 deletions.
2 changes: 1 addition & 1 deletion docs/spec/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ Notification API:

* [Alerts](v1beta2/alerts.md)
* [Providers](v1beta2/providers.md)
* [Git Commit Status Updates](v1beta2/statusupdates.md)
* [Events](v1beta2/events.md)

The alert delivery method is **at-most once** with a timeout of 15 seconds.
The controller performs automatic retries for connection errors and 500-range response code.
Expand Down
Loading

0 comments on commit 16012ce

Please sign in to comment.