This repo contains the documentation for Event Alerts.
IMPORTANT: Use PRs to contribute new content or make fixes to this Event Alerts documentation.
The contents of this repo are currently published at docs-pcf-staging.cfapps.io/event-alerts/.
The book file that publishes this content is at https://github.com/pivotal-cf/docs-book-event-alerts.
The name of this product is Event Alerts. The plugin is the Event Alerts plugin, which users can install from Pivnet.
When you are referring generically to an alert as a concept (rather than referring to the actual product), use the term "alerts" consistently.
Make changes or PRs to the correct branch:
| Branch name | Use for… |
|---|---|
| main | v1.3.x pre-release (out-of-date, see story: 178166468) |
| 1.2 | v1.2.x GA release |
| 1.1 | v1.1.x (this was a closed beta) |
Note: Provide instructions in your PRs to indicate which branches you want Docs to apply your commits to.
Other branches will be created for future versions.
Some questions tech writers had for PMs during the first documentation phase are summarized in this google doc.
This will make the book available at localhost:4567 and automatically update when you write changes to disk:
cd docs-book-event-alerts
bundle install
bundle exec bookbinder watch