Skip to content

Making the docs match the codebase#163

Merged
IanMadd merged 4 commits into
mainfrom
jfm/knife19-resource-doc-updates
Apr 17, 2026
Merged

Making the docs match the codebase#163
IanMadd merged 4 commits into
mainfrom
jfm/knife19-resource-doc-updates

Conversation

@johnmccrae

Copy link
Copy Markdown
Contributor

Description

Using the tools at hand, I am trying to make the docs match the codebase. I audited the online docs and then brought the results of that to chef and compared them. Then I took THOSE results and brought them here to update. It turns out that a number of things missing online are already here but not published yet. This should update a number of things to bring the docs into closer parity with the codebase.

Version

These are changes for Chef Infra Client versions: 19.2

Definition of done

Issues resolved

Related PRs

Checklist

  • spellcheck
  • use relref shortcode for links to Client docs in this doc set
  • all tests pass

Signed-off-by: John McCrae <john.mccrae@progress.com>
@johnmccrae johnmccrae requested a review from a team as a code owner April 15, 2026 20:31
@netlify

netlify Bot commented Apr 15, 2026

Copy link
Copy Markdown

Deploy Preview for chef-infra-client ready!

Name Link
🔨 Latest commit 1e83533
🔍 Latest deploy log https://app.netlify.com/projects/chef-infra-client/deploys/69e23c82eef95500089014cc
😎 Deploy Preview https://deploy-preview-163--chef-infra-client.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

johnmccrae and others added 3 commits April 16, 2026 15:53
Signed-off-by: John McCrae <john.mccrae@progress.com>
Signed-off-by: Ian Maddaus <ian.maddaus@progress.com>
@IanMadd IanMadd merged commit 8a8479a into main Apr 17, 2026
10 of 11 checks passed
@IanMadd IanMadd deleted the jfm/knife19-resource-doc-updates branch April 17, 2026 14:06
github-actions Bot pushed a commit that referenced this pull request Apr 17, 2026
* Making the docs match the codebase

Signed-off-by: John McCrae <john.mccrae@progress.com>

* Update resource YAML metadata versions

* Correcting linting problems

Signed-off-by: John McCrae <john.mccrae@progress.com>

* Editing

Signed-off-by: Ian Maddaus <ian.maddaus@progress.com>

---------

Signed-off-by: John McCrae <john.mccrae@progress.com>
Signed-off-by: Ian Maddaus <ian.maddaus@progress.com>
Co-authored-by: Ian Maddaus <ian.maddaus@progress.com>
(cherry picked from commit 8a8479a)
@github-actions

Copy link
Copy Markdown

💚 All backports created successfully

Status Branch Result
release-19.1

Questions ?

Please refer to the Backport tool documentation and see the Github Action logs for details

IanMadd added a commit that referenced this pull request Apr 17, 2026
* Making the docs match the codebase



* Update resource YAML metadata versions

* Correcting linting problems



* Editing



---------




(cherry picked from commit 8a8479a)

Signed-off-by: John McCrae <john.mccrae@progress.com>
Signed-off-by: Ian Maddaus <ian.maddaus@progress.com>
Co-authored-by: John McCrae <john.mccrae@progress.com>
Co-authored-by: Ian Maddaus <ian.maddaus@progress.com>
@IanMadd IanMadd mentioned this pull request Apr 17, 2026
3 tasks
IanMadd added a commit to chef/chef-web-docs that referenced this pull request Apr 21, 2026
Signed-off-by: Ian Maddaus <ian.maddaus@progress.com>
IanMadd added a commit to chef/chef-web-docs that referenced this pull request Apr 22, 2026
Signed-off-by: Ian Maddaus <ian.maddaus@progress.com>
IanMadd added a commit to chef/chef-web-docs that referenced this pull request Apr 25, 2026
Signed-off-by: Ian Maddaus <ian.maddaus@progress.com>
IanMadd added a commit to chef/chef-web-docs that referenced this pull request Apr 25, 2026
* WIP

Signed-off-by: Ian Maddaus <ian.maddaus@progress.com>

* Very WIP

Signed-off-by: Ian Maddaus <ian.maddaus@progress.com>

* It build Client 19 docs

Signed-off-by: Ian Maddaus <ian.maddaus@progress.com>

* Config updates

Signed-off-by: Ian Maddaus <ian.maddaus@progress.com>

* Create Client 18 content

Signed-off-by: Ian Maddaus <ian.maddaus@progress.com>

* Update resource YAML files

Signed-off-by: Ian Maddaus <ian.maddaus@progress.com>

* Update resources layouts to match new data path

Signed-off-by: Ian Maddaus <ian.maddaus@progress.com>

* Update Client 19 resources YAML files

Signed-off-by: Ian Maddaus <ian.maddaus@progress.com>

* Remove resource links from resource yaml files

Signed-off-by: Ian Maddaus <ian.maddaus@progress.com>

* Delete old pages

Signed-off-by: Ian Maddaus <ian.maddaus@progress.com>

* Dump the client 18 content

Signed-off-by: Ian Maddaus <ian.maddaus@progress.com>

* Fix some errors

Signed-off-by: Ian Maddaus <ian.maddaus@progress.com>

* More updates

Signed-off-by: Ian Maddaus <ian.maddaus@progress.com>

* Update theme

Signed-off-by: Ian Maddaus <ian.maddaus@progress.com>

* update Netlify config

Signed-off-by: Ian Maddaus <ian.maddaus@progress.com>

* Fix version selector config

Signed-off-by: Ian Maddaus <ian.maddaus@progress.com>

* Remove deprecations

Signed-off-by: Ian Maddaus <ian.maddaus@progress.com>

* Update theme

Signed-off-by: Ian Maddaus <ian.maddaus@progress.com>

* Update theme...again

Signed-off-by: Ian Maddaus <ian.maddaus@progress.com>

* Update theme

Signed-off-by: Ian Maddaus <ian.maddaus@progress.com>

* linting fixes

Signed-off-by: Ian Maddaus <ian.maddaus@progress.com>

* Lint fixes

Signed-off-by: Ian Maddaus <ian.maddaus@progress.com>

* Fix lints

Signed-off-by: Ian Maddaus <ian.maddaus@progress.com>

* Remove unused reusable text files

Signed-off-by: Ian Maddaus <ian.maddaus@progress.com>

* Update theme again

Signed-off-by: Ian Maddaus <ian.maddaus@progress.com>

* Update AWS Marketplace doc in Automate section

Signed-off-by: Ian Maddaus <ian.maddaus@progress.com>

* Add REST custom resource doc

Signed-off-by: Ian Maddaus <ian.maddaus@progress.com>

* Update resource docs chef/chef-client-docs#163

Signed-off-by: Ian Maddaus <ian.maddaus@progress.com>

* Update knife bootstrap doc

Signed-off-by: Ian Maddaus <ian.maddaus@progress.com>

* Update links

Signed-off-by: Ian Maddaus <ian.maddaus@progress.com>

* Lint fixes

Signed-off-by: Ian Maddaus <ian.maddaus@progress.com>

* Fix links

Signed-off-by: Ian Maddaus <ian.maddaus@progress.com>

* Move content around and fix links

Signed-off-by: Ian Maddaus <ian.maddaus@progress.com>

* Update aliases

Signed-off-by: Ian Maddaus <ian.maddaus@progress.com>

* Menu fixes

Signed-off-by: Ian Maddaus <ian.maddaus@progress.com>

* Fix more links

Signed-off-by: Ian Maddaus <ian.maddaus@progress.com>

* Update labeler config

Signed-off-by: Ian Maddaus <ian.maddaus@progress.com>

* Fix menu parameter

Signed-off-by: Ian Maddaus <ian.maddaus@progress.com>

* Update theme

Signed-off-by: Ian Maddaus <ian.maddaus@progress.com>

* Update menu config

Signed-off-by: Ian Maddaus <ian.maddaus@progress.com>

* Update target_credentials file doc in Agentless

Signed-off-by: Ian Maddaus <ian.maddaus@progress.com>

* Update search config

Signed-off-by: Ian Maddaus <ian.maddaus@progress.com>

* Update agentless mode menu

Signed-off-by: Ian Maddaus <ian.maddaus@progress.com>

* Update credentials file note

Signed-off-by: Ian Maddaus <ian.maddaus@progress.com>

---------

Signed-off-by: Ian Maddaus <ian.maddaus@progress.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants