Skip to content

feat(docs): introduce workbench follow-up automation guide - #612

Merged
michaeljguarino merged 5 commits into
mainfrom
feat/add-workbench-action-docs
Aug 6, 2026
Merged

feat(docs): introduce workbench follow-up automation guide#612
michaeljguarino merged 5 commits into
mainfrom
feat/add-workbench-action-docs

Conversation

@floreks

@floreks floreks commented Jul 30, 2026

Copy link
Copy Markdown
Member

New feature documentation:

  • Datadog integration: Introduces a dedicated guide for connecting Datadog to workbenches, detailing setup, permissions, attaching to workbenches, query behavior, and troubleshooting. The main tools page now links directly to this documentation. [1] [2] [3]
  • Post-merge follow-up automation: Adds a guide for automating workbench follow-up prompts after pull requests merge, including a full GitHub Actions workflow example, authentication methods, inputs/outputs, and advanced usage. The automation overview and navigation are updated to reference this feature. [1] [2] [3] [4]

Navigation and terminology updates:

  • Updates doc navigation to include "Datadog integration" under Workbench tools and "Automating workbench follow-up" as a new section.
  • Updates UI terminology to consistently refer to the "Launch" tab for starting new jobs, instead of the "Jobs" tab, across multiple guides. [1] [2] [3]

Tool description enhancements:

  • Clarifies the Datadog tool in the main tools table, linking to the new integration guide and specifying support for metrics, logs, and traces.

Plural Flow: docs
Plural Preview: docs

- Add detailed documentation on automating workbench follow-up tasks after pull request merges and GitOps reconciliation completes
- Include specific instructions for setting up GitHub Actions to send follow-up prompts
- Update routing structure to integrate new follow-up automation documentation
- Extend automation overview to include post-merge follow-up jobs in workbenches
- Regenerate routes with updated last modified timestamps
@floreks floreks self-assigned this Jul 30, 2026
@floreks
floreks requested a review from a team as a code owner July 30, 2026 14:02

@plural-copilot plural-copilot Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

🔧 Deploy preview for docs-pr-612 is building...

Name Details
⚡ Service docs-pr-612 (4 / 5 ready)
☁️ Cluster plural (eks)
:octocat: Commit sha 7154c2c
Plural URL https://console.mgmt.plural.sh/cd/clusters/446acdef-8524-425a-a49f-5336a...
🔍 Logs URL https://console.mgmt.plural.sh/cd/clusters/446acdef-8524-425a-a49f-5336a...
🌊 Flow URL https://console.mgmt.plural.sh/flows/08a17af1-8578-449e-9ae1-28ccd97eafc...
Preview Link Preview

You can learn more about preview environments and Plural Flows here

@greptile-apps

greptile-apps Bot commented Jul 30, 2026

Copy link
Copy Markdown
Contributor

Greptile Summary

This PR expands the Workbench documentation:

  • Adds guides for Datadog integration and post-merge follow-up automation.
  • Adds the new guides to generated routes and documentation navigation.
  • Updates Workbench instructions to use the current Launch tab terminology.
  • Adds screenshots illustrating Datadog configuration and usage.

Confidence Score: 5/5

The PR appears safe to merge.

No blocking failure remains.

Important Files Changed

Filename Overview
pages/plural-features/workbenches/follow-up-automation.md Adds the GitHub Actions follow-up automation guide, including authentication, workflow configuration, inputs, outputs, and commit-based PR resolution.
pages/plural-features/workbenches/tools/datadog.md Adds setup, permission, attachment, query, and troubleshooting documentation for the Datadog Workbench integration.
pages/plural-features/workbenches/automation.md Extends the automation overview with post-merge follow-up jobs and links to the dedicated guide.
src/routing/docs-structure.ts Adds the Datadog and follow-up automation guides to the Workbench navigation structure.
generated/routes.json Registers routes for the two newly added Workbench documentation pages.

Reviews (2): Last reviewed commit: "feat(docs): add Datadog integration and ..." | Re-trigger Greptile

@michaeljguarino michaeljguarino left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

mostly looks good, one minor improvement

Comment thread pages/plural-features/workbenches/follow-up-automation.md Outdated
- Add Docker image build and deployment steps to GitHub Actions workflow
- Update prompts to reflect deployment and verification of live changes
- Refine documentation to describe updated workflow patterns and configurations
@floreks

floreks commented Jul 30, 2026

Copy link
Copy Markdown
Member Author

@michaeljguarino is this better?

- Introduce guide for integrating Datadog with workbenches to query metrics, logs, and traces.
- Update tab names from **Jobs** to **Launch** for job initiation in workbenches.
- Expand `docs-structure.ts` with new section for Datadog integration.
- Modify links in tools documentation to include Datadog integration page.
- Update workbench running jobs instructions to reflect tab name changes.
@floreks

floreks commented Jul 31, 2026

Copy link
Copy Markdown
Member Author

@greptileai

- Add detailed steps for creating API and application keys in Datadog
- Recommend using service account for application keys
- Update routing timestamps to reflect documentation changes
@michaeljguarino michaeljguarino added the new-content For new docs content. label Aug 6, 2026
@michaeljguarino
michaeljguarino merged commit 02a85bb into main Aug 6, 2026
13 of 14 checks passed
@michaeljguarino
michaeljguarino deleted the feat/add-workbench-action-docs branch August 6, 2026 15:20
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

enhancement new-content For new docs content.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants