feat: add missing jig convert information - #417
Conversation
Signed-off-by: Martin Alfke <ma@betadots.de>
There was a problem hiding this comment.
Pull request overview
Updates the DevKit migration guide to document Jig’s new ability to convert PDK-based modules for OpenVox/VoxBox compatibility, helping users transition off the PDK with less manual editing.
Changes:
- Add documentation noting
jig convertavailability (from Jig v1.5.0) and what files it updates. - Update the PDK→Jig command mapping table to include
jig convert(instead of “not needed”) and fix table formatting.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com> Signed-off-by: Martin Alfke <tuxmea@users.noreply.github.com>
|
|
||
| | You used to type... | Now you type... | Or run tools directly... | | ||
| |---------------------|------------------|----------------------------------| | ||
| | ---------------------| ------------------| ----------------------------------| |
There was a problem hiding this comment.
Was this delimiter change intentional?
It adds a space after each opening pipe but not before the closing one, so the
delimiter row no longer lines up with the header and body rows. As far as I can
tell this is the only table in docs/ shaped that way — 28 files use | --- |
and 7 use |---|.
It renders fine either way, so no real harm. Just wondering whether it's worth
reverting to keep the diff focused on the jig convert change?
| Most are shipped as gems that you'll add to a module's `Gemfile`. | ||
| This means that you'll maintain your own Ruby and Bundler installs, but most other tooling will be accessed via `bundle exec` commands in individual module repositories. | ||
|
|
||
| For simplicity, a convert command was added to Jig starting with version 1.5.0. This allows you to automatically update your module's `Gemfile`, `Rakefile`, and `spec/spec_helper.rb` to OpenVox- and VoxBox-compatible versions. |
There was a problem hiding this comment.
Small wording suggestion to match the style guide: active voice and second person
per the tone guidelines, jig convert in monospace so it matches
the table row it explains, and one sentence per line like the surrounding paragraphs.
| For simplicity, a convert command was added to Jig starting with version 1.5.0. This allows you to automatically update your module's `Gemfile`, `Rakefile`, and `spec/spec_helper.rb` to OpenVox- and VoxBox-compatible versions. | |
| Jig 1.5.0 and later includes a `jig convert` command that migrates a PDK-based module for you. | |
| It rewrites the module's `Gemfile`, `Rakefile`, and `spec/spec_helper.rb` to OpenVox- and VoxBox-compatible versions. |
Short description
Jig is now able to convert PDK based modules to VoxBox compatibility.
e.g. PDK used the puppetlabs_spec_helper gem, which has been removed from OpenVoxtesting.
Checklist
I have:
Signed-off-byannotation to each of my commitsGenerated-byorAssisted-byannotations to each of my commits created with the help of an AI agent