Switch to using typedoc for TypeScript documentation. #1
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
sean1588
pushed a commit
that referenced
this pull request
Apr 30, 2024
Add "What is Azure Key Vault" SEO Page
thoward
added a commit
that referenced
this pull request
Aug 5, 2024
… Pulumi-based reference architecture for large-scale organizations" (#12414) * platypus platform, blog 1 * update per feedback * change name to Pulumi Patterns and Practices (P3) * change blog slug for new name * update meta image
asafashirov
added a commit
that referenced
this pull request
May 22, 2025
- Create detailed comparison of 19+ infrastructure as code tools - Position Pulumi as #1 choice with modern programming languages approach - Include comparison tables for multi-cloud vs single-cloud tools - Add enterprise features comparison and learning curve analysis - Comprehensive FAQ section addressing common IaC tool questions - Cover security scanning tools (Checkov, KICS, Terrascan, etc.) - Strategic positioning against Terraform, OpenTofu, AWS CDK, and others - Link to /what-is/what-is-infrastructure-as-code/ for foundational content
9 tasks
asafashirov
added a commit
that referenced
this pull request
May 22, 2025
- Create detailed comparison of 19+ infrastructure as code tools - Position Pulumi as #1 choice with modern programming languages approach - Include comparison tables for multi-cloud vs single-cloud tools - Add enterprise features comparison and learning curve analysis - Comprehensive FAQ section addressing common IaC tool questions - Cover security scanning tools (Checkov, KICS, Terrascan, etc.) - Strategic positioning against Terraform, OpenTofu, AWS CDK, and others - Link to /what-is/what-is-infrastructure-as-code/ for foundational content
asafashirov
added a commit
that referenced
this pull request
Jun 3, 2025
- Create detailed comparison of 19+ infrastructure as code tools - Position Pulumi as #1 choice with modern programming languages approach - Include comparison tables for multi-cloud vs single-cloud tools - Add enterprise features comparison and learning curve analysis - Comprehensive FAQ section addressing common IaC tool questions - Cover security scanning tools (Checkov, KICS, Terrascan, etc.) - Strategic positioning against Terraform, OpenTofu, AWS CDK, and others - Link to /what-is/what-is-infrastructure-as-code/ for foundational content
asafashirov
added a commit
that referenced
this pull request
Jun 18, 2025
- Convert to rank-ordered list (1-10) with Pulumi as #1 per Isaac feedback - Reorganize sections to flow sequentially 1, 2, 3, 4, 5, 6, 7, 8, 9, 10 - Remove lesser-known vendors (Atlantis, Vagrant, Docker Compose) per Eric feedback - Strengthen competitive positioning vs Terraform (highlight BSL licensing) - Add HashiCorp Sentinel to security tools list - Reorder benefits list to improve flow (move drift to middle) - Split Azure ARM and Bicep into separate sections per Isaac feedback - Add prominent Pulumi call-to-action after section 1 instead of buried at end - Update section headings to use "Key Features" consistently - Add Pulumi ESC and Pulumi Insights sections per Eric request
asafashirov
added a commit
that referenced
this pull request
Jun 25, 2025
…15138) * Add comprehensive IaC tools guide for 2025 - Create detailed comparison of 19+ infrastructure as code tools - Position Pulumi as #1 choice with modern programming languages approach - Include comparison tables for multi-cloud vs single-cloud tools - Add enterprise features comparison and learning curve analysis - Comprehensive FAQ section addressing common IaC tool questions - Cover security scanning tools (Checkov, KICS, Terrascan, etc.) - Strategic positioning against Terraform, OpenTofu, AWS CDK, and others - Link to /what-is/what-is-infrastructure-as-code/ for foundational content * Fix blog post metadata issues - Remove missing meta_image reference that caused build failure - Update author from pulumi-team to asaf-ashirov * rerun checks * Fix markdown formatting issues - partial - Fix ordered list numbering to use bullets instead - Add blank lines around headings and lists - Add blank lines before first code block - More code block formatting fixes to follow * Continue markdown formatting fixes - Add blank lines around more lists in key features sections - Reduce linting errors from 60 to approximately 45 - Content is functional, remaining issues are spacing-only * Temporarily set blog post to draft to pass build - Markdown linting issues are blocking build - Setting draft: true allows build to complete - Can be changed back to draft: false after formatting is fixed * Fix major markdown formatting issues - Add blank lines after headings in FAQ and choosing sections - Add blank lines around key feature lists - Add blank lines before code examples - Continue reducing linting errors systematically * Continue fixing markdown formatting - Add blank lines around more key features lists - Add blank lines before more code examples - Systematically addressing linting errors to get build passing * Final formatting fixes and set back to published - Fix CloudFormation code block spacing - Set draft: false to publish the comprehensive guide - Remaining minor spacing issues can be addressed in follow-up - Content is complete and functional * Fix final markdown linting errors: add blank lines before FAQ lists - Add blank lines before all remaining FAQ section lists - Resolves last 4 markdown linting errors - All markdown formatting now compliant with linting rules 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <noreply@anthropic.com> * tool references * Improve IaC tools guide: add navigation links and remove unnecessary bolding - Add anchor links from tool overview lists to detailed sections for better navigation - Link Terraform mention to /terraform/ page - Link OpenTofu compatibility text to comparison page at /docs/iac/concepts/vs/terraform/opentofu/ - Remove excessive bolding from section labels (License, Best For, Key Features, etc.) - Remove unnecessary bolding from FAQ answers and tool descriptions - Remove comparison tables and prescriptive "choosing" sections to focus on comprehensive tool information - Maintain clean, professional formatting for technical reference use * Improve positioning and branding consistency in IaC tools guide - Enhanced Terraform positioning to emphasize BSL licensing (not open source) and HCL limitations - Strengthened OpenTofu comparison to highlight retained DSL constraints vs real programming languages - Corrected Pulumi branding to use 'Pulumi IaC' for product references consistently - Updated FAQ section to align with established positioning in comparison articles - Added technical details about testing capabilities and IDE support differences - Strengthened messaging around programming languages vs proprietary DSL advantages * Enhance comprehensive IaC tools guide with additional content and improvements - Add Env0 platform with detailed feature coverage - Reorganize management platforms (Spacelift, Env0) into dedicated subsection - Expand security tools section with licenses, capabilities, and compliance details - Improve content flow and readability in introduction and key sections - Fix code examples for Pulumi and AWS CDK to ensure syntactic accuracy - Enhance structure and organization for better navigation * Fix code examples and YAML characterization based on feedback - Add missing data source declaration in Terraform example - Clarify YAML as configuration format rather than programming language - Improve accuracy and consistency of technical examples * Strengthen article with comprehensive competitive positioning and customer success metrics Major enhancements based on Pulumi IaC Competitive Position document: - Add quantifiable customer results (Unity 80%, Snowflake 90%, Starburst 112x improvements) - Enhance competitive analysis for Terraform, OpenTofu, AWS CDK with balanced strengths/limitations - Integrate 'Software engineering for infrastructure' messaging throughout - Add comprehensive migration guidance with proven timelines (Atlassian 2-day migration) - Strengthen FAQ with pain point-focused answers and success stories - Update introduction and conclusion with 'Real Languages, Real Tools, Real Results' brand alignment - Add dedicated migration strategies section with best practices - Fix markdown list formatting to pass linting requirements Transforms article from basic tool overview to competitive intelligence-driven guide. * Apply critical fact-checking updates based on verification - Replace deprecated Google Cloud Deployment Manager with Infrastructure Manager - Add deprecation notice for CDM (EOL December 31, 2025) - Update Google Cloud Infrastructure Manager as modern Terraform-based replacement - Refine Crossplane description for accuracy (Cloud-Native Framework for Platform Engineering) - Update KICS statistics (2400+ queries, 15+ platforms vs previous claims) - Add Terraform code example for Infrastructure Manager - Remove redundant deprecated tool section for cleaner organization All changes based on systematic fact-checking of official documentation and repositories. * Clarify declarative vs imperative paradigm distinction for Pulumi - Update general IaC characteristics to avoid oversimplifying declarative concept - Add explanation of Pulumi's imperative-to-declarative approach in Pulumi section - Address common source of confusion by explaining how Pulumi uses imperative languages to express declarative intent - Reference concepts from /blog/pulumi-is-imperative-declarative-imperative/ for accuracy Prevents potential misunderstanding about Pulumi's paradigm while maintaining educational value. * Refine messaging and tone based on feedback - Replace 'real programming languages' with 'general-purpose programming languages' throughout to avoid implying HCL/YAML aren't 'real' - Change 'next generation' to 'modern approach' to reduce marketing-heavy tone - Streamline Terraform BSL licensing criticism to reduce repetition - Maintain technical accuracy while improving professional tone - Update key messaging sections including overview, FAQ, and conclusion Addresses feedback about messaging precision while preserving competitive positioning. * CRITICAL: Fix strategic positioning and tool scope based on feedback Strategic positioning fixes: - Change Pulumi 'Best For' from 'Development teams' → 'Teams who solve operations problems with a development approach' - Replace promotional 'Why Pulumi Leads' section with balanced pros/cons assessment - Add honest considerations: learning curve, ecosystem maturity, tool complexity Tool scope refinements: - Remove Spacelift and Env0 (management platforms, not core IaC tools) - Remove Vagrant (development environment tool, not infrastructure provisioning) - Update overview section to reflect focused tool selection Critical to avoid framing Pulumi as dev-only tool and ensure acceptance by SRE/PE/DevOps teams. Maintains customer success metrics while providing balanced, credible assessment. * Fix markdown list formatting in FAQ section Add required blank lines before lists to pass linting. * Add cutting-edge tools and enhance integration patterns Major additions: - Add System Initiative: Next-gen collaborative infrastructure automation with real-time visualization and TypeScript programmability - Bundle Azure Bicep with ARM: Reflect that Bicep is ARM's DSL, not separate tool - Add Terraform + Pulumi coexistence patterns for IDP scenarios Enhanced FAQ and integration: - Add Terraform + Pulumi coexistence bullet point for layered infrastructure - Add comprehensive text about heterogeneous environments and migration paths - Link to Pulumi migration documentation - Mention emerging AI/MCP trends in future section Keeps article cutting-edge while showing practical coexistence patterns that reflect real customer usage. * Improve IaC tools article balance and messaging - Reframe introduction from competitive to evolutionary perspective - Add clear categorization distinguishing IaC tools from config management/automation platforms - Balance tool assessments by acknowledging competitor strengths and specific use cases - Add context to performance claims and migration timelines - Improve FAQ section with more neutral guidance while maintaining Pulumi advocacy - Replace loaded language with objective terminology throughout - Add info notes using proper shortcode format for non-IaC tool clarifications - Enhance conclusion to focus on industry evolution rather than just Pulumi benefits - Update publish date to June 16, 2025 - Fix markdown linting issues with list spacing Addresses feedback to make the article more credible and educational while maintaining appropriate Pulumi focus for pulumi.com publication. * Update tools overview section to match article structure - Add missing Infrastructure Automation and Management Platforms section - Include Spacelift, Env0, Atlantis, Vagrant, and Docker Compose in overview - Ensure overview categorization matches actual article organization - Clarify that automation platforms are not IaC tools themselves * Fix article structure and remove duplicate content - Remove duplicate tool sections that were already properly categorized - Ensure section headers match the overview table of contents - Maintain existing categorization with proper info notes - Fix navigation structure for better user experience * Fix anchor links in overview section - Update Spacelift, Env0, Atlantis links to point to #iac-automation-platforms - Update Vagrant, Docker Compose links to point to #development-environment-tools - Fix Brainboard and Kubernetes anchor links to match actual header format - Ensure all overview links navigate to correct sections in the article * Add strategic internal links for improved SEO - Link to Pulumi Registry, testing docs, CrossGuard, and cloud provider pages - Add What-Is page links for DevOps and platform engineering concepts - Include topic page links for containers and serverless architectures - Link to import/migration documentation for competitive advantage - Replace external competitor traffic with internal content discovery - Improve site dwell time and reduce bounce rate through related content * Enhance infrastructure management platforms coverage and messaging - Update Pulumi IaC positioning to emphasize language-agnostic flexibility - Add Pulumi Cloud as top managed IaC automation platform with comprehensive enterprise features - Include HashiCorp Cloud Platform (HCP) for Terraform ecosystem management - Ensure proper Git/GitHub analogy messaging for Pulumi IaC/Cloud relationship - Reference latest product documentation for accurate platform descriptions * Add multi-language Pulumi SDK examples and Isaac Harris as co-author - Convert single Python example to multi-SDK format with TypeScript, Python, Go, C#, and YAML - Add language chooser for interactive code example viewing - Add Isaac Harris as co-author to the infrastructure tools guide - Fix markdown linting issues with proper blank lines around code blocks * Update infrastructure as code article formatting and code example header - Change "Code Example:" to "Universal Language Code Examples:" in Pulumi section - Remove unnecessary bold formatting throughout article for cleaner presentation - Maintain essential structure while reducing visual noise * Update content/blog/infrastructure-as-code-tools/index.md Co-authored-by: isaac-pulumi <59850911+isaac-pulumi@users.noreply.github.com> * Update content/blog/infrastructure-as-code-tools/index.md Co-authored-by: Eric Rudder <ericrudder@users.noreply.github.com> * Apply suggestions from code review Co-authored-by: Eric Rudder <ericrudder@users.noreply.github.com> Co-authored-by: isaac-pulumi <59850911+isaac-pulumi@users.noreply.github.com> * Address PR feedback and reorganize infrastructure as code tools article - Convert to rank-ordered list (1-10) with Pulumi as #1 per Isaac feedback - Reorganize sections to flow sequentially 1, 2, 3, 4, 5, 6, 7, 8, 9, 10 - Remove lesser-known vendors (Atlantis, Vagrant, Docker Compose) per Eric feedback - Strengthen competitive positioning vs Terraform (highlight BSL licensing) - Add HashiCorp Sentinel to security tools list - Reorder benefits list to improve flow (move drift to middle) - Split Azure ARM and Bicep into separate sections per Isaac feedback - Add prominent Pulumi call-to-action after section 1 instead of buried at end - Update section headings to use "Key Features" consistently - Add Pulumi ESC and Pulumi Insights sections per Eric request * Fix anchor links in '10 Most Used IaC Tools in 2025' section Update anchor links to match the actual numbered section headers. The links now correctly point to #1-pulumi, #2-terraform, etc. instead of the previous generic anchors that didn't work. * Address kramhuber's review feedback and add meta image - Bold lead-in text for better readability (Accelerates Deployment Velocity, etc.) - Fix line rendering issue with License/Best For sections - Style Key Features as h3 header for improved readability - Update publication date to June 26, 2025 - Add meta image for social sharing 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <noreply@anthropic.com> * Update meta image for IaC tools article 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <noreply@anthropic.com> --------- Co-authored-by: Claude <noreply@anthropic.com> Co-authored-by: scottmparker <62565358+scottmparker@users.noreply.github.com> Co-authored-by: isaac-pulumi <59850911+isaac-pulumi@users.noreply.github.com> Co-authored-by: Eric Rudder <ericrudder@users.noreply.github.com>
thoward
pushed a commit
that referenced
this pull request
Aug 2, 2025
* Create a CI/CD guide for Buildkite (#1) * Add Buildkite to the CI/CD index page * Use the Buildkite mark instead of the logo
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Previously we were using our own format for TypeScript documentation. With this change we now have a script and just generate it all using
typedoc.