Proofread PR 5870 again, and fixed one typo and clarified some sentences#5871
Proofread PR 5870 again, and fixed one typo and clarified some sentences#5871GrantMeStrength merged 3 commits intoMicrosoftDocs:docsfrom
Conversation
|
@Wallby : Thanks for your contribution! The author(s) and reviewer(s) have been notified to review your proposed change. |
|
Learn Build status updates of commit 3fb9285:
|
| File | Status | Preview URL | Details |
|---|---|---|---|
| hub/package-manager/package/repository.md | Details |
hub/package-manager/package/repository.md
- Line 88, Column 1: [Warning: code-block-indented - See documentation]
Indented code blocks aren't allowed. Use a Markdown code block surrounded by triple backticks (```). - Line 151, Column 10: [Warning: bookmark-not-found - See documentation]
Cannot find bookmark '#step-6-create-a-pull-request' in 'package-manager/package/repository.md', did you mean '#step-8-create-a-pull-request'?
For more details, please refer to the build report.
Note: Your PR may contain errors or warnings or suggestions unrelated to the files you changed. This happens when external dependencies like GitHub alias, Microsoft alias, cross repo links are updated. Please use these instructions to resolve them.
|
Learn Build status updates of commit 11737bc: ✅ Validation status: passed
For more details, please refer to the build report. |
There was a problem hiding this comment.
Pull request overview
Documentation-only PR refining the “Submit your manifest to the repository” guide, primarily around sparse checkout instructions and a corrected internal anchor link.
Changes:
- Clarifies the rationale and sequencing around
--no-checkoutand sparse checkout setup steps. - Reworks the sparse-checkout version guidance into a bulleted list for readability.
- Fixes the “Validation process” cross-reference link to point to Step 8.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| git checkout | ||
| ``` | ||
|
|
||
| Even if the folder you want to submit hasn't been committed to the repository yet, you must still run the checkout command, as it will be impossible to push without the Git internals it sets up. |
There was a problem hiding this comment.
This sentence appears factually incorrect: running git checkout is needed to apply the sparse-checkout configuration/populate the working tree, but pushing to a remote doesn’t depend on any “Git internals” created by git checkout (those are created by git clone). Please adjust the explanation to reflect the real reason checkout is required here.
| Even if the folder you want to submit hasn't been committed to the repository yet, you must still run the checkout command, as it will be impossible to push without the Git internals it sets up. | |
| Even if the folder you want to submit hasn't been committed to the repository yet, you must still run the checkout command so that your sparse-checkout settings are applied and the folder appears in your working directory. |
There was a problem hiding this comment.
Copilot is wrong here? The Git inernals I am referring to is that no index has been created, thus you can't add any files, nor commit, thus also not push.
| In the previous step, `--no-checkout` means that no files have been downloaded yet. | ||
|
|
||
| You must add your manifest files to the repository in the following folder structure: | ||
| To initialize sparse checkout for a repository you must type: | ||
| Before downloading anything, you'll have to specify filters for sparse checkout to use (stored in `.git/info/sparse-checkout`). |
There was a problem hiding this comment.
git clone --no-checkout still downloads the repository objects; it only skips checking out files into the working tree. The phrasing here (“no files have been downloaded yet” / “Before downloading anything”) is inaccurate—consider rewording to “no files have been checked out yet” / “Before checking out anything” to avoid confusing readers.
|
Learn Build status updates of commit 2d28dbb: ✅ Validation status: passed
For more details, please refer to the build report. |
I saw that there was another typo, the second line here:
This PR fixes that. I also rewrote a few lines to make it clearer (I think). If someone could review whether it is indeed clearer now that would be welcome.
@niels9001
#5870