Add unified resources catalog page at /resources - #4710
Closed
Kushal1272 wants to merge 1 commit into
Closed
Conversation
Introduce a single authoritative discovery page listing every resource across Chef Infra Client and Chef InSpec, with a compatibility matrix, SEO-friendly descriptions, and links to each product's documentation. The page reuses the existing data-driven resource pipeline: it reads the canonical Chef Infra Client resource YAML (data/client/19/resources) at build time and a committed InSpec snapshot (data/resources/inspec.yaml) generated from the inspec/inspec docs. Version-specific resource pages are unchanged and continue to list only resources introduced in each release. - content/resources/_index.md: new top-level page (nav via front matter) - layouts/_default/resources_matrix.html: 4-column matrix (adapted from infra_resources_all.html) - layouts/partials/resource_short_desc.html: first-sentence descriptions - data/resources/inspec.yaml: committed InSpec resource snapshot - netlify.toml: document /resources/* redirect (non-forced; the new page is served while legacy deep links still redirect) Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
✅ Deploy Preview for chef-web-docs ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
|
Superseded by #4711, which is opened from the office account with the same commit. Closing this one. |
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
2 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.
Summary
Introduces a single, authoritative Resources discovery page at
docs.chef.io/resourcesthat lists every resource across Chef Infra Client and Chef InSpec, with a compatibility matrix, SEO-friendly descriptions, and links to each product's documentation.Today,
/resourcesis only a redirect to the Infra bundled pages, and resources are documented per product and per release with no unified view. This page provides that unified catalog without replacing the existing version-specific documentation — release pages continue to list only the resources introduced in each version.What's included
content/resources/_index.md— top-level hub, registered in the Overview nav via page front matter (same pattern asplatforms.md/versions.md; nomenu.tomlchange).layouts/_default/resources_matrix.html— adapted from the existinginfra_resources_all.html. Merges the canonical Infra resource YAML (data/client/19/resources) with a committed InSpec snapshot into one 4-column compatibility matrix (Resource | Chef Infra Client | Chef InSpec | Description). Checkmark cells link to each product's authoritative page.layouts/partials/resource_short_desc.html— trims descriptions to the first sentence so cells stay scannable and SEO-friendly.data/resources/inspec.yaml— a committed snapshot of the InSpec resource catalog (name → platform, description, deprecated), generated once frominspec/inspec. InSpec docs are deployed as a separate site and aren't built from this repo, so a snapshot is the least-coupled way to include them.netlify.toml— documents the/resources/*redirect. It's non-forced (301), so Netlify serves the generated/resources/index.htmlfor the hub while legacy per-resource deep links (for example/resources/apt_package/) still redirect to the Infra resource page.Data of record
Chef Infra Client resources: 181 · Chef InSpec resources: 407 · Supported by both: 16 · Total catalog: 572.
Design rationale
Validation
raw HTML omitted/ZgotmplZ.markdownlint-cli2: 0 issues.vale --minAlertLevel warning: 0 errors/warnings.hugo_lint.shASCII rule: new content and data files are ASCII-clean.Reviewer notes
netlify.tomlredirect. Behavior relies on Netlify's file-precedence for non-forced redirects. Please confirm on a deploy preview that/resources/renders the new page and/resources/apt_package/still redirects.data/resources/inspec.yamlfor the source and how to regenerate.Intentionally out of scope (follow-ups)