Skip to content

Commit

Permalink
Merge pull request #39 from sensu/fix_readme
Browse files Browse the repository at this point in the history
Fixed README
  • Loading branch information
Todd Campbell committed Feb 12, 2021
2 parents 6c615e7 + 032a563 commit 497dce5
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 3 deletions.
3 changes: 3 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,9 @@ Versioning](http://semver.org/spec/v2.0.0.html).

## [Unreleased]

### Changed
- Fixed README

## [1.4.0] - 2021-02-08

### Changed
Expand Down
8 changes: 5 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -75,7 +75,7 @@ spec:
### Templates
This handler provides options for using templates to populate the values
provided by the event in the message sent via SNS. More information on
provided by the event in the message sent via Slack. More information on
template syntax and format can be found in [the documentation][9]
Expand All @@ -85,9 +85,9 @@ All arguments for this handler are tunable on a per entity or check basis based
on annotations. The annotations keyspace for this handler is
`sensu.io/plugins/slack/config`.

**NOTE**: Due to [check token substituion][9], supplying a template value such
**NOTE**: Due to [check token substituion][10], supplying a template value such
as for `description-template` as a check annotation requires that you place the
desired template as a [golang string literal][10] (enlcosed in backticks)
desired template as a [golang string literal][11] (enlcosed in backticks)
within another template definition. This does not apply to entity annotations.

#### Examples
Expand Down Expand Up @@ -194,3 +194,5 @@ To contribute to this plugin, see [CONTRIBUTING](https://github.com/sensu/sensu-
[7]: https://docs.sensu.io/sensu-go/latest/guides/secrets-management/
[8]: https://docs.sensu.io/sensu-go/latest/guides/secrets-management/#use-env-for-secrets-management
[9]: https://docs.sensu.io/sensu-go/latest/observability-pipeline/observe-process/handler-templates/
[10]: https://docs.sensu.io/sensu-go/latest/observability-pipeline/observe-schedule/checks/#check-token-substitution
[11]: https://golang.org/ref/spec#String_literals

0 comments on commit 497dce5

Please sign in to comment.