docs(what-is): rewrite HashiCorp Vault page#18813
docs(what-is): rewrite HashiCorp Vault page#18813alexleventer wants to merge 2 commits intomasterfrom
Conversation
Restructures the Vault what-is page to match the AWS Secrets Manager peer convention and fix several quality issues: - Fix heading hierarchy (h3 → h2 for top-level sections) - Fix "Hashicorp" → "HashiCorp" capitalization - Drop the duplicate "What is HashiCorp Vault?" heading that mirrored the H1 generated from page_title - Add an intro paragraph that leads with a definition (AEO) - Tighten the use-cases list from 8 bullets to 5 stronger ones - Add Best practices and Challenges and considerations sections - Add a Pulumi code chooser (TypeScript, Python, Go, C#) using the Pulumi Vault provider's Mount and kv.SecretV2 resources - Trim em-dash usage and remove "easier" per STYLE-GUIDE Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
Docs reviewSolid rewrite that brings the page in line with the AWS Secrets Manager peer convention. Heading hierarchy is fixed, "HashiCorp" is now consistently capitalized, em-dash usage is reasonable across the article, and the Pulumi code chooser is a real improvement on a page that previously promoted Pulumi without showing any. A few things worth a closer look before merge: Issues1. "Open-source" framing (line 14) The intro paragraph for the H2 calls Vault "an open-source tool." HashiCorp relicensed Vault Community Edition from MPL 2.0 to BUSL 1.1 (Business Source License) in August 2023, which the OSI does not classify as open source. "Source-available" is the more accurate label, and several other Pulumi pages have already been updated this way. 2. Bulleted list interrupted by the language chooser (lines 97–229) The Conclusion ends with what reads as a three-item bulleted list of next steps, but the chooser block sits between bullet 1 ("Manage Vault as code with Pulumi") and bullets 2–3 ("Centralize secrets…", "Advanced configuration management"). Hugo's renderer is likely to treat that as two separate lists, breaking the visual continuity and the numbering of next steps. Worth confirming in a local build that the three items still render as a single list, or consider restructuring — for example, lift the code chooser into its own "Manage Vault as code with Pulumi" subsection above the conclusion, then keep the next-steps list intact at the end. 3. Em-dash density inside the "What is HashiCorp Vault?" section (lines 14, 20, 22) Three em-dashes appear within ten lines of each other. The total of four across the article is fine, but clustering three in one short section reads a bit AI-flavored. Consider rephrasing one or two — for example, on line 22: Minor
Things I confirmed
If you'd like me to take another pass after these are addressed, mention @claude. |
|
Your site preview for commit 944a4af is ready! 🎉 http://www-testing-pulumi-docs-origin-pr-18813-944a4af0.s3-website.us-west-2.amazonaws.com |
CamSoper
left a comment
There was a problem hiding this comment.
Building on @claude's review with a few items I caught that weren't in there. Defer to @claude on the BSL/source-available fix — they posted a clean suggestion block for it.
Broken-ish link: HCP Vault pricing
Line 86 links "HCP Vault" to https://www.hashicorp.com/products/vault/pricing. The URL resolves, but the destination is HashiCorp's generic product-pricing page, currently centered on Terraform tiers — there's no dedicated Vault pricing on it. Either drop the link (just say "HCP Vault") or point at the actual product page (https://www.hashicorp.com/products/vault, no /pricing).
Marketing tone in two spots
A couple of lines lean further into superlatives/editorializing than the rest of the page:
- Line 10: "is one of the most widely adopted tools for that job" — unsourced superlative. Could be tightened to "is a popular tool for this" or just dropped, since the rest of the intro already establishes the use case.
- Line 19: "drastically reducing the blast radius of a leak" — editorial flourish; something like "limiting exposure if a credential leaks" reads closer to the docs voice used in the rest of the page.
Stale (but working) HashiCorp URLs
Both vaultproject.io URLs 308-redirect to developer.hashicorp.com. They work, but worth updating to the canonical destinations:
- Line 28:
https://www.vaultproject.io/downloads→https://developer.hashicorp.com/vault/downloads/ - Line 41:
https://www.vaultproject.io/docs/secrets/kv/kv-v2→https://developer.hashicorp.com/vault/docs/secrets/kv/kv-v2
Things I confirmed that aren't in @claude's review
- All four code samples verified against the live Pulumi Vault provider docs (v7.8.0): resource types, property names, package imports, and Go SDK v7 import paths all match.
- All internal Pulumi links (
/registry/packages/vault/,/docs/pulumi-cloud/esc/,/docs/pulumi-cloud/esc/providers/vault-secrets/,/docs/concepts/config/) resolve, two via aliases. - Vault CLI claims (
operator rotate,operator rekey, transit engine, audit devices) are all accurate.
On @claude's "bulleted list interrupted by the chooser" concern — worth a quick visual check on the preview, but the AWS Secrets Manager peer page uses the same bullet → chooser → bullet pattern in production, so Hugo seems to handle it. Probably not blocking.
|
Claude finished @CamSoper's task in 2m 20s —— View job Applied review feedbackPushed
A couple of items from my earlier review I left alone since they weren't in your list and you didn't flag them as blocking — happy to address any of these on request:
Local lint isn't allowed in this sandbox; CI will run it on the new commit. |
- Apply source-available framing per BSL relicense (Aug 2023) - Soften unsourced superlative in intro - Replace editorial "blast radius" phrasing with docs voice - Drop link from HCP Vault (pricing page was Terraform-centric; product link already used at first mention) - Update vaultproject.io URLs to canonical developer.hashicorp.com Co-authored-by: Cam Soper <CamSoper@users.noreply.github.com>
Summary
Rewrites
/what-is/what-is-hashicorp-vault/to match the AWS Secrets Manager peer convention and address several quality issues.Structural / style fixes
###, should be##)### What is HashiCorp Vault?heading that mirrored the H1 generated frompage_titleContent improvements
Mountandkv.SecretV2resources — previously the page promoted Pulumi but contained zero Pulumi codeStyle-guide cleanup
bashinstead ofshellfor the CLI fenceTest plan
/what-is/what-is-hashicorp-vault/rendering, including the language chooser🤖 Generated with Claude Code