Added chef-ice and migrate-ice support in doc #4447
Conversation
swathi-s3
requested review from
VarshiSB,
Copilot,
rishabhjhs,
sandhi18,
shanmugapriya-tr,
vipin230 and
vviveksharma
✅ Deploy Preview for chef-web-docs ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
swathi-s3
force-pushed
the
CHEF-22094
branch
5 times, most recently
from
5509cc7 to
9efc379
Compare
There was a problem hiding this comment.
Pull Request Overview
This PR updates documentation to add support for Chef Infra Client Enterprise (chef-ice) and Legacy Migration (migrate-ice), introduces the fileName and package-managers endpoints in the download APIs, and standardizes licensing references by removing “Inspec 6 or greater.”
- Updated licensing docs to reference “Chef InSpec 6” only.
- Added
fileNameendpoint to community/commercial APIs andpackage-managersto commercial. - Extended product listings and install scripts to include
chef-iceandmigrate-ice.
Reviewed Changes
Copilot reviewed 5 out of 6 changed files in this pull request and generated 3 comments.
Show a summary per file
| File | Description |
|---|---|
| content/licensing/license_key.md | Changed “Chef InSpec 6 or greater” to “Chef InSpec 6.” |
| content/licensing/_index.md | Same licensing update for InSpec reference. |
| content/download/community.md | Added /fileName endpoint and renamed Infra Client to Legacy. |
| content/download/commercial.md | Added /fileName, /package-managers, pm parameter, ICE/MIG endpoints. |
| content/chef_install_script.md | Added chef-ice support and -i package-manager flag. |
Files not reviewed (1)
- _vendor/github.com/chef/license-service/docs-chef-io/content/licensing/local_license_service/_index.md: Language not supported
Comments suppressed due to low confidence (1)
content/download/commercial.md:136
- The endpoint is documented as
/fileName(camelCase), whereas other endpoints are lowercase. Verify the exact casing in the API spec to prevent consumer confusion.
### fileName
|
vviveksharma
force-pushed
the
CHEF-22094
branch
from
e8dfa87 to
71322ec
Compare
|
@IanMadd can you please review this PR |
vviveksharma
force-pushed
the
CHEF-22094
branch
2 times, most recently
from
613868c to
ba8d2aa
Compare
vviveksharma
changed the title
|
@IanMadd Gentle reminder to review this |
|
The one issue here is it's not clear what the difference is between Client, Client Enterprise, and Client Legacy Migration. On this page we document the products you can download, but it only mentions Client. https://docs.chef.io/download/#product-download-and-install-documentation We could link to the Enterprise Chef page (I assume it's the same thing), but then what is Legacy Migration? On the supported versions page, we mention Client, but not ICE or Legacy Migration. |
@IanMadd |
I think we should link to the Enterprise Chef page for an explanation of the difference between Client and Client Enterprise. I don't think the name "Chef Infra Client Legacy Migration" makes any sense. It is an 17/18 -> 19 migration tool, and says nothing about whether or not you were a commercial user or not. It should simply be called the "Chef Infra Client Migration Tool". Otherwise, we are implying that you can only use it to migrate installs of "legacy/community" installations - which we do not want our customers thinking of themselves as users of the free version of our software. |
… greater Signed-off-by: Swathi <swathi.s@progress.com>
Signed-off-by: Ian Maddaus <ian.maddaus@progress.com>
Signed-off-by: Ian Maddaus <ian.maddaus@progress.com>
|
Description
Definition of Done
Issues Resolved
https://progresssoftware.atlassian.net/browse/CHEF-22094
Related PRs
Check List