Skip to content

changes made in migrate tool section as per the latest functional changes#134

Merged
IanMadd merged 3 commits intoclient-19from
varunsharma5/migrate-tool-changes
Jan 27, 2026
Merged

changes made in migrate tool section as per the latest functional changes#134
IanMadd merged 3 commits intoclient-19from
varunsharma5/migrate-tool-changes

Conversation

@varunsharma5
Copy link
Contributor

Changes made in migrate tool section as per the latest functional changes

Description

Updated Chef Infra Client migration tool documentation with the following improvements:

Tool Rename

  • Changed all references from chef-migrate to migrate-ice across all documentation files

Download Method Updates

  • Replaced hardcoded S3 URLs with API-based download approach
  • Added two-step process: fetch latest version, then download package
  • Introduced architecture-specific download instructions (e.g., linux.x86_64.tar.url)
  • Added placeholders: <VERSION>, <LICENSE_ID>, <CHEF_TAR_URL>, <CHEF_TAR_DOWNLOAD_URL>

Installation Methods

  • Added two installation methods for online environments:
    • Method 1: Using download URL (no license key required)
    • Method 2: Using version number (requires license key)
  • Clarified that air-gapped installations don't require license key parameter

New Flag Documentation

  • Added --chef-version flag documentation in reference.md
  • Included valid/invalid usage examples
  • Documented version format requirements (19.x.x) and validation behavior

Files Modified

  • _index.md - Tool name and CLI reference link
  • install.md - Download instructions, installation methods, tool name
  • install_airgap.md - API-based downloads, tool name, placeholders
  • upgrade_online.md - Download instructions, tool name, license key handling
  • upgrade_airgap.md - Chef tar download via API, architecture-specific URLs, tool name
  • reference.md - All command examples, new --chef-version flag documentation

User Experience Improvements

  • Clearer prerequisite instructions (have License ID ready before downloading)
  • Better explanation of JSON response structure and which fields to use
  • More user-friendly language and step-by-step guidance

Version

These are changes for Chef Infra Client version(s):

  • 19 GA
  • RC3
  • RC2
  • RC1

Definition of done

Issues resolved

Related PRs

Checklist

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

@varunsharma5 varunsharma5 requested a review from a team as a code owner January 27, 2026 14:54
Signed-off-by: Ian Maddaus <ian.maddaus@progress.com>
Signed-off-by: Ian Maddaus <ian.maddaus@progress.com>
@IanMadd IanMadd merged commit 8b71919 into client-19 Jan 27, 2026
5 checks passed
@IanMadd IanMadd deleted the varunsharma5/migrate-tool-changes branch January 27, 2026 23:16
IanMadd added a commit that referenced this pull request Jan 28, 2026
…nges (#134)

* changes made in migrate tool section as per the latest functional changes

* Editing

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

* Fix lints

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

---------

Signed-off-by: Ian Maddaus <ian.maddaus@progress.com>
Co-authored-by: Varun Sharma <varun.sharma@progerss.com>
Co-authored-by: Ian Maddaus <ian.maddaus@progress.com>
IanMadd added a commit that referenced this pull request Feb 2, 2026
…nges (#134)

* changes made in migrate tool section as per the latest functional changes

* Editing

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

* Fix lints

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

---------

Signed-off-by: Ian Maddaus <ian.maddaus@progress.com>
Co-authored-by: Varun Sharma <varun.sharma@progerss.com>
Co-authored-by: Ian Maddaus <ian.maddaus@progress.com>
IanMadd added a commit that referenced this pull request Feb 3, 2026
* Initial content migration

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

* It renders now

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

* More organization work

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

* Update vale lint gh action

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

* Very WIP

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

* Remove Workstation content

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

* More editing and organization

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

* Update Client run text

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

* Markdownlint fixes

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

* Cspell fixes

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

* Clean up vale lints

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

* Link fixes

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

* Agentless updates

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

* License content

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

* Install content

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

* Fixes

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

* Linting fixes

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

* Small corrections to agentless docs (#126)

* Small corrections to agentless docs

Signed-off-by: neha-p6 <neha.pansare@progress.com>

* Update content/agentless/_index.md

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

---------

Signed-off-by: neha-p6 <neha.pansare@progress.com>
Signed-off-by: Ian Maddaus <ian.maddaus@progress.com>
Co-authored-by: Ian Maddaus <IanMadd@users.noreply.github.com>

* Remove nonexistent resource #128

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

* Fix cspell ignore

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

* changes made in migrate tool section as per the latest functional changes (#134)

* changes made in migrate tool section as per the latest functional changes

* Editing

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

* Fix lints

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

---------

Signed-off-by: Ian Maddaus <ian.maddaus@progress.com>
Co-authored-by: Varun Sharma <varun.sharma@progerss.com>
Co-authored-by: Ian Maddaus <ian.maddaus@progress.com>

* Remove terraform provider doc (#135)

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

* Update resources release 19 (#138)

* remove osx_profile resource

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

* Update reusable text files used with resources

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

* Update layouts

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

* Minor updates

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

* cspell lint fixes

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

* Add warning about resource accuracy

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

---------

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

* Update license requirements text (#139)

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

* Update system requirements (#141)

* Update system requirements

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

* Add supported platforms to sys requirements page

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

---------

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

* Update download URLs (#140)

* Update download URLs

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

* Update installer URLs

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

---------

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

* Hide bootstrap page (#142)

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

* Add warning text about FIPS mode (#144)

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

* Add text about accepting EULA (#143)

* Add text about EULA

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

* Fix heading levels

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

---------

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

* Fix links

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

* Fix lint errors

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

---------

Signed-off-by: Ian Maddaus <ian.maddaus@progress.com>
Signed-off-by: neha-p6 <neha.pansare@progress.com>
Co-authored-by: neha-p6 <npansare@progress.com>
Co-authored-by: Varun Sharma <sharmav@progress.com>
Co-authored-by: Varun Sharma <varun.sharma@progerss.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