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

Add extra warning to "Installing add-ons" section of User Guide #16510

Open
wants to merge 16 commits into
base: master
Choose a base branch
from

Conversation

Qchristensen
Copy link
Member

Following discussion on #16486, the purpose of this PR is to add more warning / ways of verifying add-ons to the add-on section of the User Guide. This can then be referred to from the quick start guide changed proposed in #16486.

Link to issue number:

Summary of the issue:

Intention is to expand on the warning of the risks of add-ons mentioned in the user guide, and offer some suggestions for users to reassure themselves about the author of add-ons prior to installing.

(It should perhaps also be noted, there is no new or additional risk with add-ons than there ever has been. We just want to be sure users are aware of what add-ons are and can do before installing them).

Description of user facing changes

Update user guide with additional paragraph of information.

Description of development approach

Testing strategy:

Known issues with pull request:

Code Review Checklist:

  • Documentation:
    • Change log entry
    • User Documentation
    • Developer / Technical Documentation
    • Context sensitive help for GUI changes
  • Testing:
    • Unit tests
    • System (end to end) tests
    • Manual testing
  • UX of all users considered:
    • Speech
    • Braille
    • Low Vision
    • Different web browsers
    • Localization in other languages / culture than English
  • API is compatible with existing add-ons.
  • Security precautions taken.

Added a new paragraph warning about add-ons and list of ways to verify add-ons to user guide.
@Adriani90
Copy link
Collaborator

@Qchristensen please also see #16316.

user_docs/en/userGuide.md Outdated Show resolved Hide resolved
user_docs/en/userGuide.md Outdated Show resolved Hide resolved
@seanbudd seanbudd added the conceptApproved Similar 'triaged' for issues, PR accepted in theory, implementation needs review. label May 14, 2024
user_docs/en/userGuide.md Outdated Show resolved Hide resolved
user_docs/en/userGuide.md Outdated Show resolved Hide resolved
@seanbudd seanbudd marked this pull request as ready for review June 11, 2024 08:32
@seanbudd seanbudd requested a review from a team as a code owner June 11, 2024 08:32
@@ -3387,6 +3387,14 @@ It is very important to only install add-ons from sources you trust.
The functionality of add-ons is unrestricted inside NVDA.
This could include accessing your personal data or even the entire system.

Copy link
Member Author

Choose a reason for hiding this comment

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

Suggested change
Add-ons are scanned by [Virus Total](https://www.virustotal.com/), however, this only detects known malware at submission time.

Copy link
Member

Choose a reason for hiding this comment

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

did you want to commit this somewhere?

Copy link
Member

Choose a reason for hiding this comment

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

I think it would be better to part of the previous paragraph

Copy link
Member Author

Choose a reason for hiding this comment

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

I initially had it at the end of that paragraph, but just reading it again as a whole:

"Just because an add-on is available in the NVDA Add-on Store, does not mean that it has been approved or vetted by NV Access or anyone else. It is very important to only install add-ons from sources you trust. The functionality of add-ons is unrestricted inside NVDA. This could include accessing your personal data or even the entire system."

Perhaps between "... approved or vetted by NV Access or anyone else." and "It is very important to only install add-ons from sources you trust..." would be better?

Copy link
Member

Choose a reason for hiding this comment

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

that makes sense to me

user_docs/en/userGuide.md Outdated Show resolved Hide resolved
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
blocked/needs-internal-fix blocked conceptApproved Similar 'triaged' for issues, PR accepted in theory, implementation needs review.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants