Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Documentation updates for event and metric triggers #12366

Merged
merged 5 commits into from
Mar 21, 2024

Conversation

chrisguidry
Copy link
Collaborator

As part of our expansion of triggers to new use cases, I wanted to refresh the
documentation for triggers to make room for docs about metric and composite
triggers.

@chrisguidry chrisguidry requested a review from a team as a code owner March 20, 2024 21:21
Copy link

netlify bot commented Mar 20, 2024

Deploy Preview for prefect-docs-preview ready!

Name Link
🔨 Latest commit a8c78a1
🔍 Latest deploy log https://app.netlify.com/sites/prefect-docs-preview/deploys/65fc6d6b1aed8e000861e462
😎 Deploy Preview https://deploy-preview-12366--prefect-docs-preview.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

@kevingrismore
Copy link
Contributor

❤️ ❤️ ❤️

Copy link
Collaborator

@zzstoatzz zzstoatzz left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

woot! this is so exciting

@@ -47,7 +47,7 @@ On the **Automations** page, select the **+** icon to create a new automation. Y

### Triggers

Triggers specify the conditions under which your action should be performed. Triggers can be of several types, including triggers based on:
Triggers specify the conditions under which your action should be performed. The Prefect UI includes templates for many common situations, like:
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

nit

Suggested change
Triggers specify the conditions under which your action should be performed. The Prefect UI includes templates for many common situations, like:
Triggers specify the conditions under which your action should be performed. The Prefect UI includes templates for many common situations, such as:

Copy link
Contributor

@billpalombi billpalombi left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Proposing a few minor edits for clarity.

I think we should avoid the word "stream" because of some of the connotations it carries. It we need a word, I'm more comfortable with "event feed", but in most cases I think we can get a away with just "events."

docs/concepts/automations.md Outdated Show resolved Hide resolved
docs/concepts/automations.md Outdated Show resolved Hide resolved
docs/concepts/automations.md Outdated Show resolved Hide resolved
docs/concepts/automations.md Outdated Show resolved Hide resolved
As part of our expansion of triggers to new use cases, I wanted to refresh the
documentation for triggers to make room for docs about metric and composite
triggers.

Co-authored-by: nate nowack <thrast36@gmail.com>
Co-authored-by: Bill Palombi <bill@prefect.io>
Copy link
Contributor

@discdiver discdiver left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good stuff! Minor nits.

docs/concepts/automations.md Outdated Show resolved Hide resolved
docs/concepts/automations.md Outdated Show resolved Hide resolved
docs/concepts/automations.md Outdated Show resolved Hide resolved
docs/concepts/automations.md Outdated Show resolved Hide resolved
chrisguidry and others added 2 commits March 21, 2024 12:02
Co-authored-by: Jeff Hale <discdiver@users.noreply.github.com>
Copy link
Contributor

@discdiver discdiver left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

lgtm

@chrisguidry chrisguidry merged commit 75f3ffd into main Mar 21, 2024
8 checks passed
@chrisguidry chrisguidry deleted the triggers-documentation branch March 21, 2024 17:38
serinamarie pushed a commit that referenced this pull request Apr 5, 2024
Co-authored-by: nate nowack <thrast36@gmail.com>
Co-authored-by: Bill Palombi <bill@prefect.io>
Co-authored-by: Jeff Hale <discdiver@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants