Add Quick Start Guide to NVDA User Guide by Qchristensen · Pull Request #13934 · nvaccess/nvda

Qchristensen · 2022-07-21T09:37:31Z

Link to issue number:

NA

Summary of the issue:

User requests for a more in-depth guide to help new users get started with NVDA. The guide has been written with the intention of including it in the User Guide, but also being able to easily separate it out into a standalone document where needed.

The quick start guide also helps bring users onboard in such a way as to give them enough information to get started, and also include information about other resources (eg training material and user groups), to ensure they are able to find additional support if needed.

Description of user facing changes

Move System Requirements to become section 1.2
Make new "Quick Start Guide" section 2, with sections on downloading NVDA, installing NVDA and Running NVDA (and smaller topics in the quick start guide on preferences, getting help, community.
The idea is that the Quick Start Guide will also be able to be used outside the user guide as a standalone document.
Section 3 "More setup options" includes most of the original section 3, but renamed as "Getting and setting up NVDA" could be confusing next to "Quick start guide". Most of the text is unchanged, as although slightly repetitious after the quick start guide, the quick start guide walks deeply through (default) options where "More setup options" covers other details, such as information on portable copies.

I appreciate this is a large documentation update and I apologise in advance to the translators. I am deeply grateful for all your work!

Description of development approach

Early work on this was included in the Switching from Jaws to NVDA Wiki some time ago and has been favourably commented on. The text has been drafted several times with the intention of complementing the remainder of the User Guide.

Testing strategy:

Known issues with pull request:

Nonw

Change log entries:

New features
Added Quick Start Guide to User Guide

Code Review Checklist:

Pull Request description:
- description is up to date
- change log entries
Testing:
- Unit tests
- System (end to end) tests
- Manual testing
API is compatible with existing add-ons.
Documentation:
- User Documentation
- Developer / Technical Documentation
- Context sensitive help for GUI changes
UX of all users considered:
- Speech
- Braille
- Low Vision
- Different web browsers
- Localization in other languages / culture than English

- Move System Requirements to become section 1.2 - Make new "Quick Start Guide" section 2, with sections on downloading NVDA, installing NVDA and Running NVDA (and smaller topics in the quick start guide on preferences, getting help, community. - The idea is that the Quick Start Guide will also be able to be used outside the user guide as a standalone document. - Section 3 "More setup options" includes most of the original section 3, but renamed as "Getting and setting up NVDA" could be confusing next to "Quick start guide". Most of the text is unchanged, as although slightly repetitious after the quick start guide, the quick start guide walks deeply through (default) options where "More setup options" covers other details, such as information on portable copies.

AppVeyorBot · 2022-07-21T10:17:51Z

PASS: Translation comments check.
PASS: Unit tests.
PASS: Lint check.
FAIL: System tests. See test results for more information.
Build (for testing PR): https://ci.appveyor.com/api/buildjobs/d2rs2hf894m18jlt/artifacts/output/nvda_snapshot_pr13934-25954,66b9a91a.exe

See test results for failed build of commit 66b9a91aea

Co-authored-by: Łukasz Golonka <lukasz.golonka@mailbox.org>

Fixed description for items in the "Reporting location and other information"

Thanks Sean - I didn't check that part, just moved it. Co-authored-by: Sean Budd <sean@nvaccess.org>

Thanks! Co-authored-by: Sean Budd <sean@nvaccess.org>

Co-authored-by: Sean Budd <sean@nvaccess.org>

Qchristensen · 2022-07-22T01:23:33Z

Thanks @seanbudd for picking up those formatting issues!

Co-authored-by: Sean Budd <sean@nvaccess.org>

Changed single ` for double ``

Co-authored-by: Sean Budd <sean@nvaccess.org>

seanbudd · 2022-08-02T01:16:04Z

I would suggest checking the build output.

You can do this by:

Click "Show all checks" (ctrl+f to find) on this page
Click details
Navigate to artefacts (e.g. for the latest build: https://ci.appveyor.com/project/NVAccess/nvda/builds/44292974/artifacts)
download output/userGuide.html
Open output/userGuide.html in your browser.

Co-authored-by: Sean Budd <sean@nvaccess.org>

AppVeyorBot · 2022-08-02T02:43:44Z

PASS: Translation comments check.
PASS: Unit tests.
PASS: Lint check.
FAIL: System tests. See test results for more information.
Build (for testing PR): https://ci.appveyor.com/api/buildjobs/f0rn7hswhn2d9ulo/artifacts/output/nvda_snapshot_pr13934-26065,06cb14c3.exe

See test results for failed build of commit 06cb14c351

Hopefully fixed all the section headings and keystroke highlighting. Also renamed the original "Getting Started with NVDA" section to "Using NVDA" since the name was too close to the quick start guide section name. Note the quick start guide does have a topic called "Running NVDA" but I think they are different enough and one is a chapter heading and one a topic in the quick start guide. Happy for feedback though!

Co-authored-by: Sean Budd <sean@nvaccess.org>

Removed several tabs in lists, and changed keystrokes to single word, camel case (eg "down arrow" to "downArrow")

Co-authored-by: Sean Budd <sean@nvaccess.org>

Fixed several links missing #

Fixed a few more things I noticed after looking at the output. Specifically several URLs, and the steps in 2.2.1 and 2.2.2 which both had sub-lists in the middle, as well as the topic names in "Running NVDA".

Fix table headings I had a semi-colon on which broke the heading.

Fixed step numbering in 2.2.2 Steps for installing NVDA. Fixed heading for 2.3.8 web navigation

seanbudd

Excellent work @Qchristensen , excited to get this in. I've read through this thoroughly now and looks good to me. Only a few minor suggestions.

feerrenrut

Content looks good. Good work!

seanbudd

I've just committed these changes as they were minor.
Going to merge when the build succeeds. 🎉

AppVeyorBot · 2022-08-09T04:21:01Z

PASS: Translation comments check.
PASS: Unit tests.
PASS: Lint check.
FAIL: System tests. See test results for more information.
Build (for testing PR): https://ci.appveyor.com/api/buildjobs/eihfw431egi9ja52/artifacts/output/nvda_snapshot_pr13934-26120,3f8b5875.exe

See test results for failed build of commit 3f8b5875e6

The changes for #13934 were accidentally forgotton

Qchristensen requested a review from a team as a code owner July 21, 2022 09:37

lukaszgo1 reviewed Jul 21, 2022

View reviewed changes

Comment thread user_docs/en/userGuide.t2t Outdated

lukaszgo1 reviewed Jul 21, 2022

View reviewed changes

Comment thread user_docs/en/userGuide.t2t Outdated

Qchristensen and others added 2 commits July 22, 2022 10:01

Update user_docs/en/userGuide.t2t

d30d1e5

Co-authored-by: Łukasz Golonka <lukasz.golonka@mailbox.org>

Update userGuide.t2t

78bb691

Fixed description for items in the "Reporting location and other information"

seanbudd reviewed Jul 22, 2022

View reviewed changes

Comment thread user_docs/en/userGuide.t2t

seanbudd reviewed Jul 22, 2022

View reviewed changes

Comment thread user_docs/en/userGuide.t2t Outdated

seanbudd reviewed Jul 22, 2022

View reviewed changes

Comment thread user_docs/en/userGuide.t2t Outdated

seanbudd reviewed Jul 22, 2022

View reviewed changes

Comment thread user_docs/en/userGuide.t2t Outdated

seanbudd reviewed Jul 22, 2022

View reviewed changes

Comment thread user_docs/en/userGuide.t2t Outdated

seanbudd reviewed Jul 22, 2022

View reviewed changes

Comment thread user_docs/en/userGuide.t2t Outdated

Qchristensen and others added 5 commits July 22, 2022 11:00

Update user_docs/en/userGuide.t2t

140c354

Thanks Sean - I didn't check that part, just moved it. Co-authored-by: Sean Budd <sean@nvaccess.org>

Update user_docs/en/userGuide.t2t

5ca00b9

Thanks! Co-authored-by: Sean Budd <sean@nvaccess.org>

Update user_docs/en/userGuide.t2t

b9d56ca

Co-authored-by: Sean Budd <sean@nvaccess.org>

Update user_docs/en/userGuide.t2t

75d0eb1

Co-authored-by: Sean Budd <sean@nvaccess.org>

Update user_docs/en/userGuide.t2t

9b756ae

Co-authored-by: Sean Budd <sean@nvaccess.org>

seanbudd reviewed Jul 22, 2022

View reviewed changes

Comment thread user_docs/en/userGuide.t2t Outdated

Update user_docs/en/userGuide.t2t

ff526cf

Co-authored-by: Sean Budd <sean@nvaccess.org>

seanbudd self-assigned this Jul 22, 2022

Update userGuide.t2t

8423531

Changed single ` for double ``

seanbudd marked this pull request as draft July 25, 2022 05:33

seanbudd added this to the 2022.4 milestone Jul 25, 2022

Update user_docs/en/userGuide.t2t

c2fadb6

Co-authored-by: Sean Budd <sean@nvaccess.org>

seanbudd marked this pull request as ready for review August 1, 2022 06:44

seanbudd reviewed Aug 2, 2022

View reviewed changes

seanbudd marked this pull request as draft August 2, 2022 01:13

seanbudd reviewed Aug 2, 2022

View reviewed changes

Comment thread user_docs/en/userGuide.t2t Outdated

Qchristensen and others added 4 commits August 2, 2022 12:02

Update user_docs/en/userGuide.t2t

ce97fc9

Co-authored-by: Sean Budd <sean@nvaccess.org>

Update user_docs/en/userGuide.t2t

c92b80d

Co-authored-by: Sean Budd <sean@nvaccess.org>

Update user_docs/en/userGuide.t2t

dd80e62

Co-authored-by: Sean Budd <sean@nvaccess.org>

Update user_docs/en/userGuide.t2t

165e0ac

Co-authored-by: Sean Budd <sean@nvaccess.org>

Qchristensen and others added 9 commits August 4, 2022 12:10

Update user_docs/en/userGuide.t2t

1288001

Co-authored-by: Sean Budd <sean@nvaccess.org>

Update user_docs/en/userGuide.t2t

a5c0831

Co-authored-by: Sean Budd <sean@nvaccess.org>

Update formatting of user guide

45ef536

Removed several tabs in lists, and changed keystrokes to single word, camel case (eg "down arrow" to "downArrow")

Update user_docs/en/userGuide.t2t

a85896d

Co-authored-by: Sean Budd <sean@nvaccess.org>

Update userGuide.t2t

2c488bc

Fixed several links missing #

Update userGuide.t2t

e1cc347

Fixed a few more things I noticed after looking at the output. Specifically several URLs, and the steps in 2.2.1 and 2.2.2 which both had sub-lists in the middle, as well as the topic names in "Running NVDA".

Update userGuide.t2t

e1936a4

Fix table headings I had a semi-colon on which broke the heading.

Update userGuide.t2t

a9c41db

Fixed step numbering in 2.2.2 Steps for installing NVDA. Fixed heading for 2.3.8 web navigation

seanbudd reviewed Aug 8, 2022

View reviewed changes

Comment thread user_docs/en/userGuide.t2t Outdated

Comment thread user_docs/en/userGuide.t2t Outdated

Comment thread user_docs/en/userGuide.t2t

Comment thread user_docs/en/userGuide.t2t Outdated

seanbudd marked this pull request as ready for review August 8, 2022 05:57

seanbudd requested a review from feerrenrut August 8, 2022 05:57

seanbudd assigned feerrenrut and Qchristensen Aug 8, 2022

feerrenrut approved these changes Aug 8, 2022

View reviewed changes

Apply suggestions from review

fe37ffe

seanbudd approved these changes Aug 9, 2022

View reviewed changes

seanbudd merged commit a103ef1 into master Aug 9, 2022

seanbudd deleted the Qchristensen-Quick-Start-Guide branch August 9, 2022 05:26

seanbudd added a commit that referenced this pull request Aug 9, 2022

update changes for #13934

6509042

The changes for #13934 were accidentally forgotton

seanbudd mentioned this pull request Aug 9, 2022

Update changes for #13934 #13998

Merged

seanbudd added a commit that referenced this pull request Aug 10, 2022

update changes for #13934 (#13998)

1751403

The changes for #13934 were accidentally forgotton

seanbudd mentioned this pull request May 24, 2024

Add tutorial to add-on store to quick start guide #16399

Closed

Uh oh!

Conversation

Qchristensen commented Jul 21, 2022 • edited by seanbudd Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Link to issue number:

Summary of the issue:

Description of user facing changes

Description of development approach

Testing strategy:

Known issues with pull request:

Change log entries:

Code Review Checklist:

Uh oh!

AppVeyorBot commented Jul 21, 2022

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Qchristensen commented Jul 22, 2022

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

seanbudd commented Aug 2, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

AppVeyorBot commented Aug 2, 2022

Uh oh!

seanbudd left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

feerrenrut left a comment

Choose a reason for hiding this comment

Uh oh!

seanbudd left a comment

Choose a reason for hiding this comment

Uh oh!

AppVeyorBot commented Aug 9, 2022

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

Qchristensen commented Jul 21, 2022 •

edited by seanbudd

Loading

seanbudd commented Aug 2, 2022 •

edited

Loading

seanbudd left a comment •

edited

Loading