-
Notifications
You must be signed in to change notification settings - Fork 258
Pulumi Platform Security Whitepaper #16811
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
base: master
Are you sure you want to change the base?
Conversation
Documentation ReviewThank you for updating the Pulumi Platform Security Whitepaper! This is a comprehensive document that provides detailed technical information about the platform's security architecture. I've reviewed the changes and have some feedback on style and content. Critical Issues1. Missing comma on line 47 The sentence "In fully managed cloud deployments the platform is deployed..." is missing a comma after the introductory phrase. 2. Missing article on line 403 Line 403: "demonstrates mature approach" should be "demonstrates a mature approach" Style and Clarity Concerns3. Overly complex sentence structure throughout While this is a technical whitepaper, many sentences are extremely long and complex, making them difficult to parse. The Google Developer Documentation Style Guide (which this repo falls back to) recommends shorter, clearer sentences. Several examples:
Consider breaking these into shorter, more digestible sentences. For example, lines 10-13 could be split: 4. Inconsistent terminology: "application programming interface" vs "API" Throughout the document, you spell out "application programming interface" in full rather than using the widely-known acronym "API". This makes the text unnecessarily verbose. Lines 26, 52, 60, 66, 116, etc. all use the full form. Per the style guide, widely known acronyms like API don't need expansion. Consider using "API" throughout for better readability. 5. Passive voice usage Several sections use passive voice when active voice would be clearer:
Per the documentation style guide, avoid passive voice for clarity. 6. Meta description length Line 3: The meta description "A whitepaper of security topics and how they relate to the Pulumi Platform." could be more descriptive and SEO-friendly. Consider: "Technical whitepaper covering Pulumi platform architecture, cryptographic security, operational commitments, and SOC 2 Type II compliance." 7. Missing trailing newline The file should end with a trailing newline after line 411 (per AGENTS.md requirement that all new files end with a newline). Content Observations8. Update date accuracy Line 6 states "Last updated: December 2025" - please verify this is the intended date. At the time of this review, it's December 2025, so this appears correct if the intent is to reflect when this version was finalized. 9. Index page updates The changes to content/security/_index.md look good. The updated language is more concise and the link now points to the markdown version rather than the PDF. 10. Moved file handling The PR shows that pulumi-cloud-security-whitepaper.pdf is being deleted (0 additions/deletions). Per AGENTS.md requirements for moved/deleted files:
SummaryThis is a thorough and well-structured security whitepaper. The main issues are:
The content itself is comprehensive and appropriate for the technical/security audience. Once the style issues are addressed, this will be an excellent resource for customers evaluating Pulumi's security posture. Mention me (@claude) if you'd like me to help with any edits or if you want additional review after making changes! |
|
Your site preview for commit 8fb53ff is ready! 🎉 http://www-testing-pulumi-docs-origin-pr-16811-8fb53fff.s3-website.us-west-2.amazonaws.com. |
|
Your site preview for commit a4caf00 is ready! 🎉 http://www-testing-pulumi-docs-origin-pr-16811-a4caf009.s3-website.us-west-2.amazonaws.com. |
|
Your site preview for commit fded8ba is ready! 🎉 http://www-testing-pulumi-docs-origin-pr-16811-fded8bae.s3-website.us-west-2.amazonaws.com. |
| management solution. The command-line interface serves as the primary interaction point for end users, while the cloud | ||
| service provides centralized state management, deployment orchestration, policy enforcement, and collaboration features. | ||
|
|
||
| ```mermaid |
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.
tehsis
left a comment
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.
Content looks great, I'd approve it grammatically but might need a review from someone with more experience 👍 good job!
This PR adds an updated version of the Pulumi platform security whitepaper. We are now embedding the whitepaper as markdown into the website directly instead of having a separate pdf.
Resolves: #16654