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 section on add-on store to the Quick Start Guide in the User Guide #16486

Closed
wants to merge 12 commits into from

Conversation

Qchristensen
Copy link
Member

Link to issue number:

N/A

Summary of the issue:

Request from users for more initial documentation on getting around the Add-on store.
This PR adds a section to the Quick Start Guide (in the user guide) on the add-on store.

Description of user facing changes

New sub-topic in the Quick Start Guide section of the User Guide "Add-on Store" after existing section 2.4 Preferences and before 2.5 Community.

Description of development approach

Testing strategy:

Known issues with pull request:

none

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.

Add section on add-on store to the Quick Start Guide.
seanbudd
seanbudd previously approved these changes May 6, 2024
Copy link
Member

@seanbudd seanbudd left a comment

Choose a reason for hiding this comment

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

Thanks @Qchristensen - generally looks good to me

user_docs/en/userGuide.t2t Outdated Show resolved Hide resolved
user_docs/en/userGuide.t2t Show resolved Hide resolved
user_docs/en/userGuide.t2t Outdated Show resolved Hide resolved
user_docs/en/userGuide.t2t Outdated Show resolved Hide resolved
user_docs/en/userGuide.t2t Outdated Show resolved Hide resolved
+++ Searching for add-ons +++[SearchingForAddons]
As well as browsing all available add-ons, it is possible to filter the add-ons shown.
To search, press ``alt+s`` to jump to the "search" field and type the text to search for.
The list changes while typing the search, once done, press ``tab`` to go to the filtered list of add-ons.
Copy link
Member

Choose a reason for hiding this comment

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

It might be worth mentioning what fields you can search by (add-on ID, display name, publisher, author or description)

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
The list changes while typing the search, once done, press ``tab`` to go to the filtered list of add-ons.
The search field can contain information including the add-on ID, display name, publisher, author or description.
The list changes while typing the search, once done, press ``tab`` to go to the filtered list of add-ons.

Press ``tab`` to "Other Details", which lists details such as the publisher, version and homepage.
To return to the list of add-ons, press ``alt+a``, or ``shift+tab`` back to the "Available add-ons" list.

+++ Searching for add-ons +++[SearchingForAddons]
Copy link
Member

Choose a reason for hiding this comment

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

This section seems more or less identical to AddonStoreFilterSearch, perhaps it's just worth moving that section here?

Copy link
Member Author

Choose a reason for hiding this comment

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

Similar, but I think worth mentioning in both places - in fact, there shouldn't be much in the quick start guide which ISN'T replicated elsewhere, albeit reworded.

user_docs/en/userGuide.t2t Outdated Show resolved Hide resolved
user_docs/en/userGuide.t2t Outdated Show resolved Hide resolved
user_docs/en/userGuide.t2t Outdated Show resolved Hide resolved
@seanbudd seanbudd self-requested a review May 6, 2024 04:25
@seanbudd seanbudd dismissed their stale review May 6, 2024 04:26

mistaken approval

Qchristensen and others added 6 commits May 6, 2024 14:57
Co-authored-by: Sean Budd <sean@nvaccess.org>
Co-authored-by: Sean Budd <sean@nvaccess.org>
Co-authored-by: Sean Budd <sean@nvaccess.org>
Co-authored-by: Sean Budd <sean@nvaccess.org>
Co-authored-by: Sean Budd <sean@nvaccess.org>
Co-authored-by: Sean Budd <sean@nvaccess.org>
++ Add-ons ++[Addons]
Add-ons are programs which provide new or changed functionality for NVDA.
Add-ons are developed by the NVDA community, or external companies.
As with any software, it is important to be confident in the developer of an add-on before using it.
Copy link
Collaborator

Choose a reason for hiding this comment

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

Suggested change
As with any software, it is important to be confident in the developer of an add-on before using it.
As with any software, it is important to be confident in the developer of an add-on before using it.
You can do this by researching their reputation (eg. how long have they been contributing, look for user feedback in the NVDA user or add-on groups), verifying that the add-on is regularly updated, and seeking community feedback through the forums or social media.

Copy link
Member Author

Choose a reason for hiding this comment

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

We should probably mention the "Community reviews" here?

I'm also not sure we should add too much more here when we don't actually mention this in 13.2 - perhaps we should expand on this in 13.2 and add a brief mention here that "As with any software, it is important to be confident in the developer of an add-on before using it. Section 13.2.1 contains tips on researching add-ons and authors, such as community reviews"?

Copy link
Collaborator

Choose a reason for hiding this comment

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

That sounds like a better solution.

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 have created PR #16510 to add @gerald-hartig's suggestions to the main add-on section. I'd like to propose that PR be accepted at the same time or before this one, so the following makes sense:

Suggested change
As with any software, it is important to be confident in the developer of an add-on before using it.
As with any software, it is important to be confident in the developer of an add-on before using it.
Please refer to [Installing Add-ons #AddonStoreInstalling] for ways to verify add-ons prior to installation.

@seanbudd seanbudd added the conceptApproved Similar 'triaged' for issues, PR accepted in theory, implementation needs review. label May 7, 2024
Qchristensen and others added 3 commits May 7, 2024 16:42
Co-authored-by: Sean Budd <sean@nvaccess.org>
Co-authored-by: gerald-hartig <153188145+gerald-hartig@users.noreply.github.com>
Available add-ons are listed alphabetically in a grid.
Use the ``arrow keys`` or press the first letter of an add-on name to move around the list.
Press ``tab`` once to move to a description of the currently selected add-on.
Use the reading or ``arrow keys`` to read the full description.
Copy link
Member Author

Choose a reason for hiding this comment

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

We don't give instructions like this through most of the user guide (that's more a training module area). I feel saying something like this is needed here until #16485 is implemented (if that were implemented, I think we could drop this line). In the meantime, I've suggested"reading text" which links to the quick start guide topic of that name - https://www.nvaccess.org/files/nvda/documentation/userGuide.html#ReadingText Otherwise we could say "Use the Say all, or navigation keys"?

Suggested change
Use the reading or ``arrow keys`` to read the full description.
Use the [reading text #ReadingText] or ``arrow keys`` to read the full description.

Copy link
Collaborator

Choose a reason for hiding this comment

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

@Qchristensen I'm not sure "use the reading text" makes sense. It's like "Use the force", without there being a force. :-)

I get that you mean it to be read "Use the reading text keys, or the arrow keys", but even that sounds awkward since "reading text keys" aren't a thing.
"reading keys", okay, as a general shorthand for "review or object nav keys", but "reading text keys"? Hmmm.

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 would like an excuse to write "Use the force" in the user guide somewhere! Happy to accept a change here - I was originally thinking of saying use "Say all", but that is just one of any number of keys you COULD use to read text with. I don't think there are (many, or any?) other examples of this kind of instruction in the User Guide, as it's not how it is written. If we could have NVDA read that whole text field on focus it would negate the need to give any specific instruction here :) I wasn't keen to leave it unsaid though as it is easy to get to that description field, have it read one line and not know whether there is more or that you need to specifically read it if there is.

I just had a look in Basic Training and I mention "Reading keys" or "Reading and navigation keys" in a couple of places.

Copy link
Contributor

Choose a reason for hiding this comment

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

Perhaps this is more of a discussion for #16485 but for me NVDA reports that this field is multiline, which pretty clearly indicates there may be more than one line there. Why it is a problem in the add-on store specifically and not in many other places - when tabbing into an multiline edit field on web pages for example?

Co-authored-by: Sean Budd <sean@nvaccess.org>
Co-authored-by: Luke Davis <8139760+XLTechie@users.noreply.github.com>
@Qchristensen
Copy link
Member Author

This PR has been superseded by #16553 against the md file rather than the t2t file. I believe I've incorporated all the suggestions made to date. Please make any future suggestions against the new PR.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
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.

None yet

5 participants