Skip to content
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

Open
wants to merge 13 commits into
base: docs
Choose a base branch
from

Conversation

cgaarden
Copy link
Contributor

@cgaarden cgaarden commented Jan 25, 2025

PowerToys New+

  1. Updated documentation to describe the up and coming variable support in template filenames (35287)
  2. Changed the date
  3. Added a few bookmarks to enable additional linking from PowerToys settings

IMPORTANT: These documentation updates are dependent on PR in the https://github.com/microsoft
PowerToys repo.
PowerToys related PR: microsoft/PowerToys#37074

Copy link
Contributor

@cgaarden : Thanks for your contribution! The author(s) have been notified to review your proposed change.

Copy link
Contributor

Learn Build status updates of commit 0fe7113:

✅ Validation status: passed

File Status Preview URL Details
hub/powertoys/newplus.md ✅Succeeded

For more details, please refer to the build report.

For any questions, please:

Copy link
Contributor

PRMerger Results

Issue Description
File Change Percent This PR contains file(s) with more than 30% file change.

Copy link
Contributor

@alvinashcraft alvinashcraft left a 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.

hub/powertoys/newplus.md Outdated Show resolved Hide resolved
hub/powertoys/newplus.md Outdated Show resolved Hide resolved
hub/powertoys/newplus.md Outdated Show resolved Hide resolved
hub/powertoys/newplus.md Outdated Show resolved Hide resolved
hub/powertoys/newplus.md Outdated Show resolved Hide resolved
hub/powertoys/newplus.md Outdated Show resolved Hide resolved
cgaarden and others added 6 commits January 27, 2025 17:00
Copy link
Contributor

Learn Build status updates of commit f90f9ac:

⚠️ Validation status: warnings

File Status Preview URL Details
hub/docfx.json ⚠️Warning 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:

Copy link
Contributor

Learn Build status updates of commit 55c71ef:

⚠️ Validation status: warnings

File Status Preview URL Details
hub/docfx.json ⚠️Warning 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:

Removed unnecessary bookmarks in headings based on feedback (thank you!)
Copy link
Contributor

Learn Build status updates of commit ed9b5cc:

⚠️ Validation status: warnings

File Status Preview URL Details
hub/docfx.json ⚠️Warning 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:

Copy link
Contributor

@alvinashcraft alvinashcraft left a 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.


##### Special variables

These special variables are case-sensitive, so they will only work when written exactly as shown here.
Copy link
Contributor

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.

Copy link
Contributor Author

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.


##### Environment variables

These variables are case-insensitive, meaning you can write them in a mix of uppercase or lowercase.
Copy link
Contributor

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"

Copy link
Contributor Author

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


##### Examples

| Example template filename | Would on copy expand to |
Copy link
Contributor

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.

Copy link
Contributor Author

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"

@Jay-o-Way
Copy link
Contributor

Jay-o-Way commented Feb 10, 2025

Since the headers on learn already can be linked to, please remove the <a > tags [...]

This is a valid comment for the whole document :)

@cgaarden
Copy link
Contributor Author

Since the headers on learn already can be linked to, please remove the <a > tags [...]

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!)
Copy link
Contributor

Learn Build status updates of commit e2ed98b:

✅ Validation status: passed

File Status Preview URL Details
hub/powertoys/newplus.md ✅Succeeded

For more details, please refer to the build report.

For any questions, please:

Copy link
Contributor

PRMerger Results

Issue Description
File Change Percent This PR contains file(s) with more than 30% file change.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants