docs: remove internal-only references from contributor and how-to docs#677
Open
bfjelds wants to merge 7 commits into
Open
docs: remove internal-only references from contributor and how-to docs#677bfjelds wants to merge 7 commits into
bfjelds wants to merge 7 commits into
Conversation
- Pull-Requests.md: Remove internal ADO ECF Dev Guide link, update DevOps-specific language to GitHub terminology (abandon -> close, remove note about DevOps lacking label support) - Trident-Architecture.md: Replace empty placeholder with comprehensive architecture documentation including execution modes, engine design, subsystem lifecycle, storage pipeline, A/B update mechanism, gRPC server, datastore, COSI format, commands reference, design principles, and 8 mermaid diagrams - PXE-Boot-In-QEMU.md: Replace internal argus-toolkit dependency with standard cpio/zcat/gzip commands, fix initrd typo, add Host Configuration reference link Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Shows the path from user inputs through engine and subsystems to the target OS desired state. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
bfjelds
changed the title
Contributor
There was a problem hiding this comment.
Pull request overview
Removes Microsoft-internal-only references from contributor and how-to documentation so external contributors can follow the guidance without needing internal Azure DevOps/ADO resources.
Changes:
- Updates the PXE boot in QEMU guide to modify the initrd using standard
zcat/cpio/gziptooling and documents Trident’s expected config location inside the initramfs. - Removes an internal-only ECF Dev Guide link from PR guidelines and updates Azure DevOps terminology (“abandon”) to GitHub terminology (“close”).
- Tightens wording in the PR labels section to focus on title prefix labels for draft/proposal-style PRs.
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 1 comment.
| File | Description |
|---|---|
| docs/How-To-Guides/PXE-Boot-In-QEMU.md | Replaces internal tooling instructions with portable initrd unpack/patch/repack steps and links to Host Configuration reference. |
| docs/Development/Contributing/Pull-Requests.md | Removes internal doc link and updates PR workflow terminology to match GitHub. |
Prevents cpio from extracting absolute paths outside the working directory, which could overwrite system files when run as root. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Trident generates initrds with dracut --zstd, so the PXE guide should use zstdcat/zstd instead of zcat/gzip. Added a note for users with gzip-compressed images. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
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
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.
Summary
Removes references that require internal Microsoft access with no public alternative, making these docs fully usable by external contributors.
Changes
Pull-Requests.md
PXE-Boot-In-QEMU.md