rework documentation #21
Merged
Conversation
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
Contributor
Author
|
Putting this in draft for now--there are a couple of bits of prose I'd like to tweak before merging, but most things should be ready for feedback. |
Try to improve a few things about the documentation: - Lift the guest-internet-connection requirement into the top of the usage instructions - Move discussion of configuration options into a new document, CONFIGURING.md - Add some rudimentary troubleshooting guidelines (turn on the VGA console and see where it's stuck; instructions for getting at the OxidePrepBaseImage.ps1 output, since this is a common source of errors)
sudomateo
force-pushed
the
gjcolombo/rework-docs
branch
from
4816e78 to
50582e0
Compare
sudomateo
reviewed
May 9, 2025
Contributor
sudomateo
left a comment
sudomateo
left a comment
There was a problem hiding this comment.
I resolved the merge conflicts and the documentation looks good to me but I have not yet tried to use this windows-image-builder myself yet. @qdzlug I believe you tried to use this earlier this week. Would you be able to comment on these changes?
Contributor
|
Since this PR was opened, there have been a lot of changes to this repo - however, these changes do not impact this PR, primarily because we created a new adoc for the windows use case. Will merge - #26 will track the cleanup. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Try to improve a few things about the documentation:
This includes the
wimtoolsinstructions added in #20 (but moves them to CONFIGURING.md) and instructions for selecting an edition to install via product key (as in #15).