[WIP, DO NOT MERGE] [IA option 1] Balanced Get Started on-ramp#3478
Closed
SharpRake wants to merge 14 commits into
Closed
[WIP, DO NOT MERGE] [IA option 1] Balanced Get Started on-ramp#3478SharpRake wants to merge 14 commits into
SharpRake wants to merge 14 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>
# 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>
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>
Brings in Chainguard Agent Skills docs (chainguard-dev#3395), pnpm trustPolicy limitation (chainguard-dev#3424), cosign fix (chainguard-dev#3423), and AutoDocs/API regen. Conflict resolution (AutoDocs-generated chainctl reference): upstream renamed `chainctl libraries policy-gate` to `chainctl libraries policy` and added `chainctl actions catalog/list`. Accepted upstream's regenerated, url-pinned files at our moved content/platform/ path and dropped the superseded policy-gate files. No aliases (url-pinned). Signed-off-by: Mark Drake <mark@chainguard.dev>
…urce Move the Console bucket from Chainguard Products to Platform & Tools (/chainguard/console/ -> /platform/console/), placed alphabetically at weight 050; shift Factory, FIPS, and Integrations down to make room. Repoint 13 inbound links across 11 files. Swap the top-level section weights so Compliance sits above Open Source. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com> Signed-off-by: Mark Drake <mark@chainguard.dev>
…ducts Set weight 010 so the bucket sorts first in the section, and normalize the camelCase linkTitle key to linktitle to match the sibling buckets. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com> Signed-off-by: Mark Drake <mark@chainguard.dev>
# Conflicts: # content/platform/administration/custom-idps/idp-providers/okta/okta-1.png # content/platform/administration/custom-idps/idp-providers/okta/okta-2.png # content/platform/administration/custom-idps/idp-providers/okta/okta-3.png # content/platform/administration/custom-idps/idp-providers/okta/okta-4-5.png # content/platform/administration/custom-idps/idp-providers/okta/okta-6.png # content/platform/chainctl/chainctl-docs/chainctl_images_helm_refs.md
Render a `crosslinks` list of {title, url} pairs from a section or
subsection _index.md as pointer entries in the sidebar, with an
external-link icon and working active-state. Cross-links are pointers,
not copies: one canonical page, one URL.
First use: a new get-started/containers-examples subsection pointing at
the nginx, PostgreSQL, Python, and Go getting-started guides, plus a
cross-link from Compliance to Selecting a Base Image.
Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Signed-off-by: Mark Drake <mark@chainguard.dev>
…base # Conflicts: # .github/actions/integrate-platform-docs/action.yaml # content/platform/chainctl/chainctl-docs/chainctl_libraries_artifacts.md # content/platform/chainctl/chainctl-docs/chainctl_libraries_artifacts_count.md # content/platform/chainctl/chainctl-docs/chainctl_libraries_artifacts_list.md # content/platform/chainctl/chainctl-docs/chainctl_libraries_artifacts_versions.md # content/platform/integrations/kiro.md
Implements the suggestions from get-started-balanced-docs.md as a reviewable scaffold. Net-new docs use Lorem ipsum placeholders; on-ramp docs that map to published content are wired as sidebar cross-links. Net-new (placeholder): - What is Chainguard? — conceptual front door for both pillars - Key concepts and terminology — one glossary spanning containers + libraries - Quickstart: pull and run your first container — stack-agnostic hello-world - _index.md rewritten as a "pick your path" router Cross-links to published content: - Containers Examples: + "Authenticate to the registry" - New Libraries Examples subsection: quickstart, access, network requirements, how-libraries-help-developers 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. |
SharpRake
changed the title
Collaborator
Author
|
superseded by: #3499 |
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
1 participant
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.
What this is
A scaffold for the team to review — IA option 1 for the docs restructure. It builds on the information-architecture work in #3407 and adds a reworked Get Started section. Draft, not for merge: the net-new pages hold placeholder text so we can evaluate the structure before writing real content.
This option focuses on Get Started only. It does not add a new top-level section.
The Get Started rework
The current Get Started section bundles three jobs — onboarding, first build, and migration — and migration dominates. This option reframes it as an orientation-and-first-build on-ramp that treats Chainguard Containers and Chainguard Libraries as two co-equal paths. It follows the plan in
get-started-balanced-docs.md.New pages (placeholder Lorem ipsum):
Cross-links to already-published docs (using the existing sidebar cross-link mechanism, so nothing is duplicated):
How to review
Read it as a structure proposal, not finished copy. The questions for the team:
Notes
main, so it includes the full IA restructure from Split Product Docs into Get Started, Chainguard Products, and Platform & Tools #3407 plus a merge of the latest upstreammain. The changes unique to this option are the six files undercontent/get-started/.🤖 Generated with Claude Code