-
Notifications
You must be signed in to change notification settings - Fork 1.2k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
PowerToys New+ variable support in template filenames -- documentation related updates #5285
base: docs
Are you sure you want to change the base?
PowerToys New+ variable support in template filenames -- documentation related updates #5285
Conversation
@cgaarden : Thanks for your contribution! The author(s) have been notified to review your proposed change. |
Learn Build status updates of commit 0fe7113: ✅ Validation status: passed
For more details, please refer to the build report. For any questions, please:
|
PRMerger Results
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks for these updates! I left some comments inline. Since the headers on learn already can be linked to, please remove the <a >
tags from the new headers you've added.
Co-authored-by: Alvin Ashcraft <[email protected]>
Co-authored-by: Alvin Ashcraft <[email protected]>
Co-authored-by: Alvin Ashcraft <[email protected]>
Co-authored-by: Alvin Ashcraft <[email protected]>
Co-authored-by: Alvin Ashcraft <[email protected]>
Co-authored-by: Alvin Ashcraft <[email protected]>
Learn Build status updates of commit f90f9ac:
|
File | Status | Preview URL | Details |
---|---|---|---|
hub/docfx.json | Details | ||
hub/powertoys/newplus.md | ✅Succeeded |
hub/docfx.json
- Line 47, Column 25: [Warning: ms-service-subservice-invalid - See documentation]
Invalid value for 'ms.subservice': 'apps' is not valid with 'ms.service' value 'traceprocessor'.
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.
For any questions, please:
- Try searching the learn.microsoft.com contributor guides
- Post your question in the Learn support channel
Learn Build status updates of commit 55c71ef:
|
File | Status | Preview URL | Details |
---|---|---|---|
hub/docfx.json | Details | ||
hub/powertoys/newplus.md | ✅Succeeded |
hub/docfx.json
- Line 47, Column 25: [Warning: ms-service-subservice-invalid - See documentation]
Invalid value for 'ms.subservice': 'apps' is not valid with 'ms.service' value 'traceprocessor'.
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.
For any questions, please:
- Try searching the learn.microsoft.com contributor guides
- Post your question in the Learn support channel
Removed unnecessary bookmarks in headings based on feedback (thank you!)
Learn Build status updates of commit ed9b5cc:
|
File | Status | Preview URL | Details |
---|---|---|---|
hub/docfx.json | Details | ||
hub/powertoys/newplus.md | ✅Succeeded |
hub/docfx.json
- Line 47, Column 25: [Warning: ms-service-subservice-invalid - See documentation]
Invalid value for 'ms.subservice': 'apps' is not valid with 'ms.service' value 'traceprocessor'.
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.
For any questions, please:
- Try searching the learn.microsoft.com contributor guides
- Post your question in the Learn support channel
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks for the updates. This looks good. I'll hang onto it until the feature PR goes out in a PowerToys release.
hub/powertoys/newplus.md
Outdated
|
||
##### Special variables | ||
|
||
These special variables are case-sensitive, so they will only work when written exactly as shown here. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Sentence can be shortened. Like, "Note: Case sensitive" should suffice.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Not sure I agree - to me and you - yes :-) but I think there a lot of people who don't really know what case-sensitive/insensitive mean.
hub/powertoys/newplus.md
Outdated
|
||
##### Environment variables | ||
|
||
These variables are case-insensitive, meaning you can write them in a mix of uppercase or lowercase. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Same. Nit: to me, the word "write" sounds more like "handwriting", versus "type"
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Reworded slightly to hopefully avoid confusion
hub/powertoys/newplus.md
Outdated
|
||
##### Examples | ||
|
||
| Example template filename | Would on copy expand to | |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
- Is it a "template filename" or a "file name template"?
- I think a phrasing like "would" sounds too insecure. "Result" is simple and confident.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Filename:
We are using "filename" in the New+ settings UI and also in the existing New+ documentation. Both filename and file name are valid but started with filename and prefer to be consistent throughout.
Updated to "Result"
This is a valid comment for the whole document :) |
I didn't update the existing bookmark as that bookmark was introduce prior to this PR (and not sure Learn had the bookmark mapping enabled back then) and is used in an aka.ms link that is used within New+ settings PowerToys page. We can do as a separate PR at a future date. |
Removed unnecessary bookmarks in headings based on feedback (thank you!)
…m/cgaarden/windows-dev-docs into NewPlus-filename-variable-support
Learn Build status updates of commit e2ed98b: ✅ Validation status: passed
For more details, please refer to the build report. For any questions, please:
|
PRMerger Results
|
PowerToys New+
IMPORTANT: These documentation updates are dependent on PR in the https://github.com/microsoft
PowerToys repo.
PowerToys related PR: microsoft/PowerToys#37074