-
Notifications
You must be signed in to change notification settings - Fork 255
Add plugins concept page and integrate plugin references across docs #16406
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
Conversation
…entation This change introduces a new concept page explaining Pulumi's plugin architecture and updates related documentation to reference it. The plugins page covers all five plugin types (resource, language, analyzer, converter, and tool plugins), installation and management, and implementation details. Related documentation updates: - how-pulumi-works.md: Add reference to language plugins - providers.md: Explain providers as resource plugins - converters.md: Reference converter plugins and clarify standalone tools - policy/_index.md: Reference analyzer plugins 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <noreply@anthropic.com>
Documentation ReviewThank you for this comprehensive plugins concept page! This is a valuable addition that will help users understand Pulumi's plugin architecture. I've reviewed the changes and have the following feedback: Issues Found1. Inconsistent terminology in converters.md (lines 48-51)The heading says "Additional conversion tools and resources" and the text says "standalone tools," but the listed items include both web tools and actual converters. The crd2pulumi link goes to a blog post (not a web conversion tool like the others were), and cf2pulumi goes to a web tool. Suggestion: Clarify this section to be more consistent. Consider: 2. Minor grammar issue in converters.md (line 19)"allows you translate" is missing "to" Current (line 19): Should be: (Note: This appears to already be fixed in the diff, so this may not be an issue.) 3. Heading capitalization consistencyAll H2 and H3 headings follow sentence case correctly throughout. ✓ 4. List formatting in plugins.mdLines 65-68 use different list item formats. The first item has parenthetical text, while others don't. Consider making them more parallel. Current (lines 65-68): - **Resource plugins** (provider binaries) are installed automatically when you install dependencies in a Pulumi program using your language's package manager (e.g., `npm install`, `pip install`)
- **Language plugins** are installed with the Pulumi CLI
- **Policy plugins** are installed with the Pulumi CLI
- The Pulumi CLI ensures your resource plugins are present when you run your Pulumi programSuggestion: - **Resource plugins** (providers) are installed automatically when you install dependencies using your language's package manager (e.g., `npm install`, `pip install`)
- **Language plugins** are installed with the Pulumi CLI
- **Policy plugins** are installed with the Pulumi CLI
- **Converter plugins** are installed automatically when you run the `pulumi convert` commandThis makes the list more comprehensive and parallel. Positive Observations
Overall AssessmentThis is a well-written and comprehensive addition to the documentation. The plugins concept page provides valuable context about Pulumi's architecture. The integration points with existing docs are well-chosen. After addressing the minor issues above, this will be ready to merge. Mention @claude if you'd like me to review again after making changes or if you need help with any fixes. |
|
Your site preview for commit a70ee6b is ready! 🎉 http://www-testing-pulumi-docs-origin-pr-16406-a70ee6b5.s3-website.us-west-2.amazonaws.com. |
|
Your site preview for commit fd482ca is ready! 🎉 http://www-testing-pulumi-docs-origin-pr-16406-fd482cae.s3-website.us-west-2.amazonaws.com. |
|
Your site preview for commit d52da46 is ready! 🎉 http://www-testing-pulumi-docs-origin-pr-16406-d52da464.s3-website.us-west-2.amazonaws.com. |
Co-authored-by: Fraser Waters <fraser@pulumi.com>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I can't speak as to the accuracy of the information, but I see no issues in the presentation.
|
Your site preview for commit d41edb9 is ready! 🎉 http://www-testing-pulumi-docs-origin-pr-16406-d41edb9f.s3-website.us-west-2.amazonaws.com. |
|
Your site preview for commit 1c44a44 is ready! 🎉 http://www-testing-pulumi-docs-origin-pr-16406-1c44a441.s3-website.us-west-2.amazonaws.com. |
|
Your site preview for commit d23eaa6 is ready! 🎉 http://www-testing-pulumi-docs-origin-pr-16406-d23eaa6a.s3-website.us-west-2.amazonaws.com. |
ea201df to
0cbd400
Compare
|
Your site preview for commit d945678 is ready! 🎉 http://www-testing-pulumi-docs-origin-pr-16406-d9456788.s3-website.us-west-2.amazonaws.com. |
|
Your site preview for commit ea201df is ready! 🎉 http://www-testing-pulumi-docs-origin-pr-16406-ea201dfd.s3-website.us-west-2.amazonaws.com. |
|
Your site preview for commit 0cbd400 is ready! 🎉 http://www-testing-pulumi-docs-origin-pr-16406-0cbd4002.s3-website.us-west-2.amazonaws.com. |
|
Your site preview for commit 897be87 is ready! 🎉 http://www-testing-pulumi-docs-origin-pr-16406-897be873.s3-website.us-west-2.amazonaws.com. |
|
Your site preview for commit 9800516 is ready! 🎉 http://www-testing-pulumi-docs-origin-pr-16406-98005163.s3-website.us-west-2.amazonaws.com. |
|
Your site preview for commit 2b60072 is ready! 🎉 http://www-testing-pulumi-docs-origin-pr-16406-2b600729.s3-website.us-west-2.amazonaws.com. |
Fixes #16325
This change introduces a new concept page explaining Pulumi's plugin architecture and updates related documentation to reference it. The plugins page covers all five plugin types (resource, language, analyzer, converter, and tool plugins), installation and management, and implementation details.
Related documentation updates:
🤖 Generated with Claude Code