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

ORCA-4812: Document The dynamic_route_to action #3

Conversation

metavida
Copy link

@metavida metavida commented Jun 24, 2024

Adds documentation for the dynamic_route_to action. The wording is based partially on the proposed public-REST-API wording in ORCA-4803.

QA

I pasted the markdown into https://registry.terraform.io/tools/doc-preview and got this result:

Screen Shot 2024-06-24 at 12 31 37-fullpage

@metavida metavida changed the title ORCAA-4812: Document The dynamic_route_to action ORCA-4812: Document The dynamic_route_to action Jun 24, 2024
@@ -12,15 +12,31 @@ An Orchestration Router allows users to create a set of Event Rules. The Router

## Example of configuring Router rules for an Orchestration

In this example the user has defined the Router with two rules, each routing to a different service.

This example assumes services used in the `route_to` configuration already exists. So it does not show creation of service resource.
Copy link
Author

Choose a reason for hiding this comment

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

Annotation: I decided it was easier to include a pair of service "data source" configurations in the example, rather having these disclaimer sentences.

@@ -72,6 +88,22 @@ The following arguments are supported:
* `expression`- (Required) A [PCL condition](https://developer.pagerduty.com/docs/ZG9jOjM1NTE0MDc0-pcl-overview) string.

### Actions (`actions`) supports the following:

#### Dynamic Routing
Copy link
Author

Choose a reason for hiding this comment

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

Annotation: Unfortunately it seems the Terraform documentation site does not support deep links/anchors on H4 tags. That said I'm not immediately thinking of a better way to organize this portion of the page. Suggestions are welcome!

Copy link
Owner

Choose a reason for hiding this comment

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

I think the approach you chose is good, the Actions section is not that big so linking to Actions should be sufficient.

@metavida metavida force-pushed the ORCA-4812-document-dynamic_route_to branch from 6f74385 to dda518b Compare June 24, 2024 19:35
@metavida metavida marked this pull request as ready for review June 24, 2024 19:36
@alenapan alenapan merged commit 0c0a56d into alenapan:event-orchestration-dynamic-routing-and-esc-policy-support Jun 25, 2024
alenapan pushed a commit that referenced this pull request Jul 12, 2024
Migrate pack #3 of datasources and resources to terraform plugin framework
c-kaieong pushed a commit that referenced this pull request Jul 22, 2024
* Update the router example to use the pagerduty_service data source

* Add a dynamic router rule example

* Document the dynamic vs static router actions
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants