Skip to content

Fix obsolete navigation paths in ESC webhooks documentation #16392

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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 3 commits into from
Oct 28, 2025
Merged

Fix obsolete navigation paths in ESC webhooks documentation #16392

merged 3 commits into from
Oct 28, 2025
+40 −46

Conversation

@jkodroff
Copy link
Member

@jkodroff jkodroff commented Oct 27, 2025 •
edited
Loading

Fixes #16390

Updates navigation instructions to reflect current Pulumi Cloud UI, where organization webhooks are now found under Integrations > Webhooks rather than Settings > Webhooks. Also reorders sections to present environment webhooks before organization webhooks for better logical flow.

Additional cleanup includes removing outdated trial callout and screenshot, fixing Python code example syntax errors, correcting grammar errors, and standardizing list formatting per style guide.

🤖 Generated with Claude Code

@jkodroff @claude
Fix obsolete navigation paths in ESC webhooks documentation
1035af7 
Updates navigation instructions to reflect current Pulumi Cloud UI, where organization webhooks are now found under Integrations > Webhooks rather than Settings > Webhooks. Also reorders sections to present environment webhooks before organization webhooks for better logical flow.

Additional cleanup includes removing outdated trial callout and screenshot, fixing Python code example syntax errors, correcting grammar errors, and standardizing list formatting per style guide.

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude <[email protected]>
@jkodroff jkodroff requested a review from ringods October 27, 2025 17:33
@claude
Copy link
Contributor

claude bot commented Oct 27, 2025

Review Summary

This PR successfully updates the ESC webhooks documentation with current UI navigation paths and improves overall clarity. The changes are well-structured and address the stated issues. I found a few minor issues to address:

Issues Found

1. UI Navigation Formatting (line 61)

Location: content/docs/esc/environments/webhooks.md:61

The navigation path uses an arrow symbol (→) instead of the standard greater-than symbol (>).

Current:

1. In the main Pulumi Cloud navigation, select **Integrations** > **Webhooks**.

Issue: The STYLE-GUIDE.md specifies using arrows for navigation (e.g., Settings → API Keys), but this appears to be using the greater-than symbol (>) in the diff, which is inconsistent with the style guide.

Suggestion:

1. In the main Pulumi Cloud navigation, select **Integrations** → **Webhooks**.

2. Missing Navigation Arrow (line 42)

Location: content/docs/esc/environments/webhooks.md:42

The first bulleted item references UI navigation but doesn't use the navigation arrow format consistently.

Current:

1. Manually, in the Pulumi Cloud UI using the steps outlined in [Create an Organization Webhook in the Pulumi Cloud UI](#create-an-organization-webhook-in-the-pulumi-cloud-ui) or [Create an Environment Webhook in Pulumi Cloud in the Pulumi Cloud UI](#create-an-environment-webhook-in-the-pulumi-cloud-ui).

Issue: Minor - the phrasing "Create an Environment Webhook in Pulumi Cloud in the Pulumi Cloud UI" has a redundant "in Pulumi Cloud" that makes it awkward.

Suggestion:

1. Manually, in the Pulumi Cloud UI using the steps outlined in [Create an Organization Webhook in the Pulumi Cloud UI](#create-an-organization-webhook-in-the-pulumi-cloud-ui) or [Create an Environment Webhook in the Pulumi Cloud UI](#create-an-environment-webhook-in-the-pulumi-cloud-ui).

3. Bullet List Formatting (line 425)

Location: content/docs/esc/environments/webhooks.md:425-426

Current:

- [Managing Github Webhooks with Pulumi](/blog/managing-github-webhooks-with-pulumi/)
- [Pulumi Cloud REST API](/docs/pulumi-cloud/cloud-rest-api/)

Issue: The change from asterisk (*) to hyphen (-) for bullet lists is fine, but note that consistency matters. Ensure this matches the pattern used elsewhere in the document. The hyphen format is acceptable per CommonMark.

Positive Changes

  • ✅ Updated navigation path from "Settings > Webhooks" to "Integrations → Webhooks" (correctly reflects current UI)
  • ✅ Fixed Python code example syntax errors (proper parameter assignment)
  • ✅ Reordered sections to present environment webhooks before organization webhooks (logical improvement)
  • ✅ Removed outdated trial callout
  • ✅ Improved clarity with "ordered delivery" phrasing
  • ✅ Fixed "Create an Webhook" to "Create a Webhook" (grammar correction)
  • ✅ Standardized numbered list formatting to use 1. format per style guide
  • ✅ Improved parallel structure in webhook type descriptions

Verification Checklist

  • ✅ Style guide compliance (mostly compliant, see issue Switch to using typedoc for TypeScript documentation. #1)
  • ✅ Grammar and spelling correct
  • ✅ Code examples syntactically valid
  • ✅ Content accuracy improved
  • ✅ Links appear valid (no broken references)
  • ✅ Formatting consistent with style guide

Mention @claude if you'd like me to review any updates or need additional assistance with these changes.

@pulumi-bot
Copy link
Collaborator

Your site preview for commit 1035af7 is ready! 🎉

http://www-testing-pulumi-docs-origin-pr-16392-1035af7e.s3-website.us-west-2.amazonaws.com.

@jkodroff jkodroff requested a review from CamSoper October 28, 2025 15:51
ringods
ringods approved these changes Oct 28, 2025
View reviewed changes
Copy link
Member

@ringods ringods left a comment

Choose a reason for hiding this comment

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

For organization webhooks, a user needs to be an admin of the org to set these up. Can you add that requirement somewhere?
Regarding the location, I would write Settings > Integrations to indicate that one needs to expand Settings first to find the Integrations item.

Do ESC environment webhooks also require admin permissions? I'm not sure about that.

CamSoper
CamSoper approved these changes Oct 28, 2025
View reviewed changes
Copy link
Contributor

@CamSoper CamSoper left a comment

Choose a reason for hiding this comment

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

Good fixes!

@jkodroff @claude
Add admin permission requirement and fix navigation path for organiza…
9594bb6 
…tion webhooks

Addresses PR feedback by documenting that organization webhook creation requires admin permissions and correcting the navigation path to Settings > Integrations > Webhooks.

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude <[email protected]>
@jkodroff jkodroff enabled auto-merge (squash) October 28, 2025 18:00
@pulumi-bot
Copy link
Collaborator

Your site preview for commit 9594bb6 is ready! 🎉

http://www-testing-pulumi-docs-origin-pr-16392-9594bb67.s3-website.us-west-2.amazonaws.com.

@pulumi-bot
Copy link
Collaborator

Your site preview for commit da1f7c6 is ready! 🎉

http://www-testing-pulumi-docs-origin-pr-16392-da1f7c6a.s3-website.us-west-2.amazonaws.com.

@jkodroff jkodroff merged commit 154d12f into master Oct 28, 2025
7 checks passed
@jkodroff jkodroff deleted the jkodroff/fix-esc-webhooks branch October 28, 2025 18:09
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@ringods ringods ringods approved these changes

@CamSoper CamSoper CamSoper approved these changes

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

Location to webhook settings is no longer correct

5 participants

@jkodroff @pulumi-bot @ringods @CamSoper