Split Product Docs into Get Started, Chainguard Products, and Platform & Tools#3407
Draft
SharpRake wants to merge 7 commits into
Draft
Split Product Docs into Get Started, Chainguard Products, and Platform & Tools#3407SharpRake wants to merge 7 commits into
SharpRake wants to merge 7 commits into
Conversation
…m & Tools
Rework the docs left-nav IA: the single crowded "Product Docs" section
(14 buckets) becomes three top-level sections.
- content/get-started/ ("Get Started") — self-serve and migration
- content/chainguard/ ("Chainguard Products", URL unchanged) — Containers,
Libraries, VMs, OS, Repository, Factory
- content/platform/ ("Platform & Tools") — Administration, Integrations,
FIPS, API Reference, chainctl Usage, chainctl Reference
Also: drop "Chainguard" from each product bucket's sidebar label via
linktitle (full title kept for headings and SEO); tighten sidebar
spacing so leaf and expandable rows share one rhythm; repoint the
AutoDocs integration action and homepage links to the new paths; add
aliases on hand-authored moved pages.
Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Signed-off-by: Mark Drake <mark@chainguard.dev>
✅ Deploy Preview for ornate-narwhal-088216 ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
![github-advanced-security[bot]](https://avatars.githubusercontent.com/in/57789?s=60&v=4){kind=small}
| run: | | ||
| gcloud --quiet storage cp --project="${{ inputs.project_id }}" \ | ||
| "${{ inputs.storage_bucket }}/enforce-events/events.md" content/chainguard/administration/cloudevents/events-reference.md | ||
| "${{ inputs.storage_bucket }}/enforce-events/events.md" content/platform/administration/cloudevents/events-reference.md |
Collaborator
|
Overall, I like this so far. The separation between Get Started, Chainguard Products, and Platform & Tools is clear and easy to understand at a glance. I see that we haven't moved the Console docs yet, specifically this one and this one. Are you thinking of putting them in a folder together in Platform & Tools (that would be my thought, to parallel chainctl, but you may have a better idea)? |
Collaborator
|
This looks a lot cleaner! Things to consider for future updates: Should we have separate categories for container vs library under Migration? Currently the JS migration guide is under Libraries > JavaScript, and the Libraries Quick Start is under Libraries. Should things like "Get started with chainctl" live somewhere under the Get Started section? |
Collaborator
Author
|
@matthewhelmke I started a new @s-stumbo You read my mind about migrations! Re: chainctl, I'm not sure, and I have questions about the placement of some other docs as well. I'll catalog my questions (you and Matthew should too) and we can hammer them out as a group |
# Conflicts: # content/platform/administration/cloudevents/events-reference.md
Create a new "Console" bucket under Chainguard Products and move the Console walkthrough and Notifications guides into it: - content/chainguard/console/images-directory - content/chainguard/console/use-chainguard-notifications Both pages keep aliases to their old how-to-use URLs. Reweight Repository and OS so the section order is Containers, Libraries, VMs, Repository, Console, OS, Factory. Repoint inbound links across the docs to the new /chainguard/console/ paths. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com> Signed-off-by: Mark Drake <mark@chainguard.dev>
Collaborator
Author
|
Questions/thoughts I have about reordering things
|
Relocate getting-started-with-chainctl from Platform & Tools to a top-level item in the Get Started bucket, ordered between Self-serve and Migration. Keep its published /chainguard/chainctl-usage/ alias and repoint inbound links to the new /get-started/ path. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com> Signed-off-by: Mark Drake <mark@chainguard.dev>
Signed-off-by: Mark Drake <mark@chainguard.dev>
…work # Conflicts: # content/get-started/migration/migration-checklist.md # content/get-started/migration/migration-tips.md # content/platform/administration/cloudevents/events-reference.md # content/platform/chainctl/chainctl-docs/chainctl_iam_external-group-role-mappings.md # content/platform/chainctl/chainctl-docs/chainctl_iam_external-group-role-mappings_create.md # content/platform/chainctl/chainctl-docs/chainctl_iam_external-group-role-mappings_delete.md # content/platform/chainctl/chainctl-docs/chainctl_iam_external-group-role-mappings_list.md # content/platform/chainctl/chainctl-docs/chainctl_libraries_packages.md # content/platform/chainctl/chainctl-docs/chainctl_libraries_packages_blocked.md # content/platform/chainctl/chainctl-docs/chainctl_libraries_policy-gate.md # content/platform/chainctl/chainctl-docs/chainctl_libraries_policy-gate_binding.md # content/platform/chainctl/chainctl-docs/chainctl_libraries_policy-gate_binding_create.md # content/platform/chainctl/chainctl-docs/chainctl_libraries_policy-gate_binding_delete.md # content/platform/chainctl/chainctl-docs/chainctl_libraries_policy-gate_binding_list.md # content/platform/chainctl/chainctl-docs/chainctl_libraries_policy-gate_binding_update.md # content/platform/chainctl/chainctl-docs/chainctl_libraries_policy-gate_create.md # content/platform/chainctl/chainctl-docs/chainctl_libraries_policy-gate_delete.md # content/platform/chainctl/chainctl-docs/chainctl_libraries_policy-gate_describe.md # content/platform/chainctl/chainctl-docs/chainctl_libraries_policy-gate_disable.md # content/platform/chainctl/chainctl-docs/chainctl_libraries_policy-gate_enable.md # content/platform/chainctl/chainctl-docs/chainctl_libraries_policy-gate_list.md # content/platform/chainctl/chainctl-docs/chainctl_libraries_policy-gate_update.md
…ions Move the Chainguard Factory bucket from Chainguard Products into Platform & Tools, adding aliases from the old /chainguard/factory/ URLs and repointing internal and inbound links to /platform/factory/. Reweight both sections so their buckets render in alphabetical order: Chainguard Products (Console, Containers, Libraries, OS, Repository, VMs) and Platform & Tools (Administration, API Reference, chainctl Reference, chainctl Usage, Chainguard Factory, FIPS, Integrations). Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com> Signed-off-by: Mark Drake <mark@chainguard.dev>
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
4 participants
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.
Type of change
Documentation Update
What should this PR do?
Reorganize the documentation left-nav so the top level reflects three clear sections instead of one crowded "Product Docs" list.
Why are we making this change?
"Product Docs" had grown to 14 buckets, mixing getting-started material, product references, and platform tooling in one flat list. Splitting it into Get Started, Chainguard Products, and Platform & Tools makes the navigation easier to scan and gives new content a clear home.
What are the acceptance criteria?
/chainguard/...URLs via aliases (no broken links)How should this PR be tested?
/chainguard/migration/,/chainguard/fips/,/chainguard/api/) redirect to their new locations/chainguard/chainctl/...🤖 Generated with Claude Code