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]File actions menu docs #5137

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

Conversation

Aaron-Junker
Copy link
Contributor

Copy link
Contributor

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

Copy link
Contributor

Learn Build status updates of commit d2dce20:

⚠️ Validation status: warnings

File Status Preview URL Details
hub/powertoys/file-actions-menu.md ⚠️Warning Details
hub/dev-environment/toc.yml ✅Succeeded
hub/images/PowerToys-FileActionsMenu-HashMenu.png ✅Succeeded
hub/images/PowerToys-FileActionsMenu.png ✅Succeeded
hub/powertoys/index.md ✅Succeeded

hub/powertoys/file-actions-menu.md

  • Line 0, Column 0: [Warning: h1-missing - See documentation] H1 is required. Use a single hash (#) followed by a space to create your top-level heading.

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 6b0798b:

✅ Validation status: passed

File Status Preview URL Details
hub/dev-environment/toc.yml ✅Succeeded
hub/images/PowerToys-FileActionsMenu-HashMenu.png ✅Succeeded
hub/images/PowerToys-FileActionsMenu.png ✅Succeeded
hub/powertoys/file-actions-menu.md ✅Succeeded
hub/powertoys/index.md ✅Succeeded

For more details, please refer to the build report.

For any questions, please:

Copy link
Contributor

PRMerger Results

Issue Description
Added File(s) This PR contains added files. New files require human review.
Yaml File(s) This PR includes changes to .yml file(s) owned by another author.
File Change Percent This PR contains file(s) with more than 30% file change.
Image File This PR added or updated an image file(s).
Index File This PR contains a change to the index file.

@htcfreek
Copy link
Contributor

@Aaron-Junker
Does it make sense to update gpo docs here too? Or do you create a new PR for the gpo docs?

@Aaron-Junker
Copy link
Contributor Author

@Aaron-Junker Does it make sense to update gpo docs here too? Or do you create a new PR for the gpo docs?

Thanks for the heads-up

Copy link
Contributor

Learn Build status updates of commit 6abb44b:

💡 Validation status: suggestions

File Status Preview URL Details
hub/powertoys/grouppolicy.md 💡Suggestion Details
hub/dev-environment/toc.yml ✅Succeeded
hub/images/PowerToys-FileActionsMenu-HashMenu.png ✅Succeeded
hub/images/PowerToys-FileActionsMenu.png ✅Succeeded
hub/powertoys/file-actions-menu.md ✅Succeeded
hub/powertoys/index.md ✅Succeeded

hub/powertoys/grouppolicy.md

  • Line 94, Column 2: [Suggestion: column-header-missing - See documentation] Column headers are required for tables. Add appropriate header text, or remove any extra table cells that cause an extra column.

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

PRMerger Results

Issue Description
Added File(s) This PR contains added files. New files require human review.
Yaml File(s) This PR includes changes to .yml file(s) owned by another author.
File Change Percent This PR contains file(s) with more than 30% file change.
Image File This PR added or updated an image file(s).
Index File This PR contains a change to the index file.

Copy link
Contributor

Learn Build status updates of commit 8dad8e9:

✅ Validation status: passed

File Status Preview URL Details
hub/dev-environment/toc.yml ✅Succeeded
hub/images/PowerToys-FileActionsMenu-HashMenu.png ✅Succeeded
hub/images/PowerToys-FileActionsMenu.png ✅Succeeded
hub/powertoys/file-actions-menu.md ✅Succeeded
hub/powertoys/grouppolicy.md ✅Succeeded
hub/powertoys/index.md ✅Succeeded

For more details, please refer to the build report.

For any questions, please:

Copy link
Contributor

PRMerger Results

Issue Description
Added File(s) This PR contains added files. New files require human review.
Yaml File(s) This PR includes changes to .yml file(s) owned by another author.
File Change Percent This PR contains file(s) with more than 30% file change.
Image File This PR added or updated an image file(s).
Index File This PR contains a change to the index file.

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.

Some suggestions provided inline, mostly minor. Thanks for the new docs!

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can you create a screenshot for this menu that is less busy? It would also be better if it didn't have sensitive-looking filenames in the folder.

@@ -0,0 +1,72 @@
---
title: PowerToys File Actions Menu
description: A per shortcut invokable menu for certain file actions
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
description: A per shortcut invokable menu for certain file actions
description: A per-shortcut, invokable context menu containing a set of file actions.


![File Actions menu](../images/PowerToys-FileActionsMenu-HashMenu.png)

The PowerToys File Action Menu is a menu, which is invoked by a shortcut and allows you to perform certain actions on your selected files.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
The PowerToys File Action Menu is a menu, which is invoked by a shortcut and allows you to perform certain actions on your selected files.
The PowerToys File Action Menu is a menu, which is invoked by a shortcut and allows you to perform a set of actions on the selected file(s).

## Supported hash types

> [!WARNING]
> Certain hash types are nowadays considered unsafe (like md5 or SHA1). Please inform yourself about the insecurities of the hash types you use.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I would have pointed to a page on Learn for hash info, but some of those pages could use some updates.

Suggested change
> Certain hash types are nowadays considered unsafe (like md5 or SHA1). Please inform yourself about the insecurities of the hash types you use.
> Today, some hash types ((like md5 or SHA1)) are considered unsafe. It's important to understand the insecurities of the hash types you use. Learn more about [Secure Hash Algorithms on Wikipedia](https://wikipedia.org/wiki/Secure_Hash_Algorithms).


## Resolve shortcut

Some actions allow the option to resolve shortcuts. This will target the files that the shortcuts point to instead of the `.ink`-file itsself.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The include file with PowerToys install info should be added to the end of every page. We get a lot of feedback from people who don't understand that each of these utilities needs to be installed with PowerToys.

Suggested change
Some actions allow the option to resolve shortcuts. This will target the files that the shortcuts point to instead of the `.ink`-file itsself.
Some actions allow the option to resolve shortcuts. This will target the files that the shortcuts point to instead of the `.ink`-file itsself.
[!INCLUDE [install-powertoys.md](../includes/install-powertoys.md)]

[![File Actions Mneu screenshot](../images/PowerToys-FileActionsMenu.png)](file-actions-menu.md)
:::column-end:::
:::column span="2":::
[File Actions menu](file-actions-menu.md) adds a seperate menu to explorer invokable via a shortcut, which adds several functionalities like generating and comparing file hashes, creating a new folder with a selection of files and much more.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
[File Actions menu](file-actions-menu.md) adds a seperate menu to explorer invokable via a shortcut, which adds several functionalities like generating and comparing file hashes, creating a new folder with a selection of files and much more.
[File Actions menu](file-actions-menu.md) adds a menu to File Explorer's context menu, invokable via a shortcut. The File Actions menu adds several options, including generating and comparing file hashes, creating a new folder with a selection of files, and much more.


:::row:::
:::column:::
[![File Actions Mneu screenshot](../images/PowerToys-FileActionsMenu.png)](file-actions-menu.md)
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
[![File Actions Mneu screenshot](../images/PowerToys-FileActionsMenu.png)](file-actions-menu.md)
[![A screenshot of the File Actions menu](../images/PowerToys-FileActionsMenu.png)](file-actions-menu.md)


# File Actions menu

![File Actions menu](../images/PowerToys-FileActionsMenu-HashMenu.png)
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
![File Actions menu](../images/PowerToys-FileActionsMenu-HashMenu.png)
![A screenshot of the File Actions menu](../images/PowerToys-FileActionsMenu-HashMenu.png)

@Jay-o-Way
Copy link
Contributor

ping @Aaron-Junker

@mattwojo mattwojo removed their request for review December 12, 2024 22:03
@mattwojo mattwojo removed their assignment Dec 12, 2024
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.

5 participants