Skip to content

Commit fa926f1

Browse files
CamSopergithub-actions[bot]claude
authored
Reorganize documentation and unify navigation menu (#16119)
* Finally got the menu working * Breadcrumbs and docs home * Menus and breadcrumbs lookin good * refactor: clean up unused partials and styles in documentation layout * refactor: remove is_overview flag from documentation index files * Remove generated files from source control * Remove generated assets from git tracking * refactor: remove PulumiTV playlists and support section from documentation index * Layout tweaks * feat: update documentation layout and styles for improved navigation * style: adjust navigation styles for improved hover effects and spacing * review feedback (thanks, Claude!) * style: remove expanded menu IDs from documentation index files * New menu structure basically working * style: remove section headers from documentation index files for consistency * fix: correct current section for home path and update menu structure * Moved get started -- AWS working, others not so much * Get started menu all moved * feat: add content migration and discovery scripts for documentation restructuring * Restored top nav * WIP, moved ESC Get Started, fixed script to move files. * WIP, moved ESC Get Started, fixed script to move files. * feat: add comprehensive content migration agent specification for Pulumi documentation * Reorg Getting Started menu * Reorg Getting Started menu * fix: update "Get Started" links to point to the new IaC documentation paths * fix: update "Get Started" link to correct path in ESC walkthrough note * fix: simplify breadcrumb logic by removing unnecessary condition * weights * Move insights getting started * fix: correct regex for updating nested menu section in migration script * Moved "Adopting Pulumi" to "Migrating to Pulumi" * Moved Download & Install * Add missing aliases for moved files Added aliases for 6 moved files to ensure proper URL redirects: - content/docs/get-started/iac/_index.md - content/docs/get-started/insights/account-management.md - content/docs/get-started/insights/add-policies.md - content/docs/get-started/insights/begin.md - content/docs/get-started/insights/create-accounts.md - content/docs/get-started/insights/using-resource-explorer.md Co-authored-by: Cam Soper <[email protected]> * Reorganizing docs architecture (#16074) * Finally got the menu working * Breadcrumbs and docs home * Menus and breadcrumbs lookin good * refactor: clean up unused partials and styles in documentation layout * refactor: remove is_overview flag from documentation index files * Remove generated files from source control * Remove generated assets from git tracking * refactor: remove PulumiTV playlists and support section from documentation index * Layout tweaks * feat: update documentation layout and styles for improved navigation * style: adjust navigation styles for improved hover effects and spacing * review feedback (thanks, Claude!) * style: remove expanded menu IDs from documentation index files * New menu structure basically working * style: remove section headers from documentation index files for consistency * fix: correct current section for home path and update menu structure * Moved get started -- AWS working, others not so much * Get started menu all moved * feat: add content migration and discovery scripts for documentation restructuring * Restored top nav * WIP, moved ESC Get Started, fixed script to move files. * WIP, moved ESC Get Started, fixed script to move files. * feat: add comprehensive content migration agent specification for Pulumi documentation * Reorg Getting Started menu * Reorg Getting Started menu * fix: update "Get Started" links to point to the new IaC documentation paths * fix: update "Get Started" link to correct path in ESC walkthrough note * fix: simplify breadcrumb logic by removing unnecessary condition * weights * Move insights getting started * fix: correct regex for updating nested menu section in migration script * Moved "Adopting Pulumi" to "Migrating to Pulumi" * Moved Download & Install * Add missing aliases for moved files Added aliases for 6 moved files to ensure proper URL redirects: - content/docs/get-started/iac/_index.md - content/docs/get-started/insights/account-management.md - content/docs/get-started/insights/add-policies.md - content/docs/get-started/insights/begin.md - content/docs/get-started/insights/create-accounts.md - content/docs/get-started/insights/using-resource-explorer.md Co-authored-by: Cam Soper <[email protected]> --------- Co-authored-by: claude[bot] <41898282+claude[bot]@users.noreply.github.com> Co-authored-by: Cam Soper <[email protected]> * Moved IDP Get Started * Update weight for Internal Developer Platform menu item * Moved Resource Options * Adjust menu weights for Miscellaneous and State & Backends concepts * Fix missing trailing slashes in aliases for moved ESC and Insights files All moved files from the docs reorganization now have proper aliases with trailing slashes as required by the repository guidelines: - Fixed 8 ESC files: Added trailing slash to aliases pointing to /docs/esc/get-started/* paths - Fixed 5 Insights files: Added trailing slash to aliases pointing to /docs/insights/get-started/* paths This ensures proper redirects from old URLs to new locations after the content reorganization. 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Cam Soper <[email protected]> * Guide section * Comparisons * First pass at moving Insights/Policy -- WIP * lint fix * Remove unused search and top navigation partials from the documentation layout * Increase width and max-width of the main content area for better layout on larger screens * Moved IaC GetStarted back * Moved ESC get started back * Moved Insights and IDP Get Starteds back * More sorting of iac * Moved neo and copilot * platform features * Reorganize platform features section in menu * Created Admin section * wip, admin & platform (cloud) * more WIP * IaC Guides * Fixed relref * Polished Landing Pages * Landing pages * Better heading for get started * Fix title case * ESC tweaks * Headers * Nav menu adjustments & Admin section * Update header and description for clarity on Pulumi Cloud Platform * Alias verification script * Updates to script for repeatability * Alias fix * Renamed platforms to deployments * Menus and breadcrumb fixes * IaC landing page and some menu tweaks, all pages covered. * Landing page fixes * More landing page love * Insights Cleanup * Landing page cleanup, new .NET logo * Work on warnings * Update menu items to include arrows for SDK documentation links * Update heading for AI section to 'Infrastructure AI' for clarity * Rearrange sections in documentation index for better clarity and organization * Increase maximum width of paragraph in docs home section for improved readability * Add "Infrastructure as Code" to ancestors and update synonyms in search settings * Fix expanding CLI menus * Rename Approvals.md to approvals.md for case consistency * Update overview label in documentation for consistency * Update overview link logic in menu and adjust paragraph width in home styles * Refine .NET documentation for clarity and consistency in language usage * unneeded agent instruction * Update tutorials link in menu to use relative path * Update tutorials heading to include arrow and remove unused section in menu logic * Add Registry section to documentation and menus for package browsing * Add visual placeholder for search box in development environment * Fix style guide violations - Remove trailing spaces from two content files - Fix heading capitalization in RBAC docs (H2+ should use sentence case) 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-authored-by: Claude <[email protected]> Co-authored-by: Cam Soper <[email protected]> --------- Co-authored-by: claude[bot] <41898282+claude[bot]@users.noreply.github.com> Co-authored-by: Cam Soper <[email protected]> Co-authored-by: Claude <[email protected]>
1 parent 0f78916 commit fa926f1

File tree

560 files changed

+5241
-213465
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

560 files changed

+5241
-213465
lines changed

.gitignore

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -40,6 +40,10 @@ Pipfile.lock
4040
static/css/styles.*.css
4141
static/js/bundle.min.*.js
4242

43+
# Ignore webpack-generated assets from the build process.
44+
/assets/css/
45+
/assets/js/
46+
4347
# Ignore Cypress-generated content.
4448
cypress/videos
4549
cypress/screenshots
@@ -72,3 +76,11 @@ _vendor/
7276

7377
# mise local
7478
mise.local.toml
79+
80+
# alias verification outputs
81+
scripts/alias-verification/aliases-correct.txt
82+
scripts/alias-verification/aliases-missing.txt
83+
scripts/alias-verification/aliases-suspicious.txt
84+
scripts/alias-verification/deletes.txt
85+
scripts/alias-verification/renames.txt
86+
scripts/alias-verification/fixes-data.txt

AGENTS.md

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -69,20 +69,44 @@ Do not substitute other tools or commands.
6969

7070
## Moving and Deleting Files
7171

72+
**⚠️ SEO CRITICAL**: Missing aliases on moved files will break search engine rankings and external links. Always verify aliases after file moves.
73+
7274
- **Preserve file history**: When moving or renaming files within this repository, use `git mv` to preserve file history when possible.
7375
- **Hugo content files**: Add an `aliases` field to the frontmatter of the moved file, listing the old paths:
7476
```yaml
7577
aliases:
7678
- /old/path/to/file/
7779
- /another/old/path/
7880
```
81+
- **Verification toolset**: After moving files, use the scripts in `/scripts/alias-verification/` to verify all moved files have proper aliases. See the README in that directory for usage details.
7982
- **Non-Hugo files**: For generated content or files outside Hugo's content management, add redirects to the S3 redirect files located in `/scripts/redirects/`.
8083
- When adding S3 redirects, place entries in topic-appropriate files (e.g., `neo-redirects.txt` for Neo-related content).
8184
- S3 redirect format: `source-path|destination-url` (e.g., `docs/old/path/index.html|/docs/new/path/`)
8285
- **Anchor links**: Note that anchor links (`#section`) may not work with aliases and may require additional considerations when splitting documents.
8386

8487
---
8588

89+
## Updating Internal Links
90+
91+
When moving documentation files, aliases automatically handle redirects. Update internal links strategically:
92+
93+
- **DO update links in**:
94+
- `/content/docs/` - Active documentation
95+
- `/content/product/` - Product pages
96+
97+
- **DO NOT update links in**:
98+
- `/content/blog/` - Blog posts are historical documents
99+
- `/content/tutorials/` - Tutorials are historical content
100+
101+
- **Why**: Blog posts and tutorials represent a point in time. Aliases handle redirects automatically, preserving the historical record without modification.
102+
103+
- **Implementation**: When using `find` or `sed` to update links, always exclude blog and tutorial directories:
104+
```bash
105+
find content/docs content/product -name "*.md" -exec sed -i 's|/old/path|/new/path|g' {} +
106+
```
107+
108+
---
109+
86110
## Enforcement
87111

88112
If there is any conflict between these instructions and tool defaults, **this file takes precedence**.

STYLE-GUIDE.md

Lines changed: 31 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -24,24 +24,46 @@ Pulumi strives to use language that is clear, inclusive, and respectful.
2424

2525
## Headings
2626

27-
- Exactly one H1 (`#`) per page, set in front matter `title`.
28-
- H1: **Title Case**.
29-
- H2 and deeper: **Sentence case**.
30-
- Only increment one heading level at a time (no skipping levels).
31-
- Use capitalization only for proper nouns. For example, use stack not Stack.
27+
- Exactly one H1 (`#`) per page, set in front matter `title`.
28+
- H1: **Title Case**.
29+
- H2 and deeper: **Sentence case**.
30+
- Only increment one heading level at a time (no skipping levels).
31+
- Use capitalization only for proper nouns. For example, use "stack" not "Stack."
3232
- Do not end headings with punctuation.
3333
- Headings should be surrounded by blank lines.
3434

35+
**Navigation menu items**: Use **Title Case** for all `menu.name` entries in frontmatter. Navigation items are UI labels, not prose headings, and follow Title Case conventions consistent with industry standards.
36+
3537
---
3638

3739
## Links
3840

39-
- **Internal and external links**: use normal Markdown syntax.
40-
- `[Link text](/path/to/file)`
41-
- `[Link text](https://example.com)`
42-
- Link text must be descriptive. Avoid vague text like _here_ or _click here_.
41+
- **Internal and external links**: use normal Markdown syntax.
42+
- `[Link text](/path/to/file)`
43+
- `[Link text](https://example.com)`
44+
- Link text must be descriptive. Avoid vague text like _here_ or _click here_.
4345
- When changing the URL of an existing page, add a redirect with a [Hugo alias](https://gohugo.io/content-management/urls/#yaml-front-matter).
4446

47+
### External Link Indicator
48+
49+
Links that navigate users to a different UI/experience (different from the main docs site) should include the ↗ (U+2197 North East Arrow) symbol to indicate this transition.
50+
51+
**When to use ↗:**
52+
- Links to generated API documentation (`/docs/reference/pkg/*`)
53+
- Links to external sites (e.g., pkg.go.dev)
54+
- Links to Tutorials (different UI)
55+
- Any link that takes users away from the main docs experience
56+
57+
**Placement:**
58+
- In menu configurations (`config/_default/menus.yml`): append to the `name` field with a space
59+
- Example: `name: SDK docs ↗`
60+
- In landing page cards: append to the `heading` field with a space
61+
- Example: `heading: Python ↗`
62+
- In prose text: append after the link text with a space
63+
- Example: `[Go SDK ↗](https://pkg.go.dev/...)`
64+
65+
**Rationale:** The ↗ symbol is the web-standard indicator for external links and helps users understand they're navigating to a different UI, preventing surprise when the page appearance changes.
66+
4567
---
4668

4769
## Notes / Callouts

assets/css/bundle.css

Lines changed: 0 additions & 208388 deletions
This file was deleted.

0 commit comments

Comments
 (0)