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.

Sign up for GitHub

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

Jump to bottom

Add Quick Start Guide to NVDA User Guide #13934

Merged
merged 25 commits into from
Aug 9, 2022
Merged

Add Quick Start Guide to NVDA User Guide #13934

merged 25 commits into from
Aug 9, 2022

Conversation

Qchristensen
Copy link
Member

@Qchristensen Qchristensen commented Jul 21, 2022 •
edited by seanbudd
Loading

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

@Qchristensen
Add Quick Start Guide to NVDA User Guide
dcd6bc3 
- 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.
@Qchristensen Qchristensen requested a review from a team as a code owner July 21, 2022 09:37
@AppVeyorBot
Copy link

See test results for failed build of commit 66b9a91aea

Qchristensen and others added 2 commits July 22, 2022 10:01
@Qchristensen @lukaszgo1
Update user_docs/en/userGuide.t2t
d30d1e5 
Co-authored-by: Łukasz Golonka <lukasz.golonka@mailbox.org>
@Qchristensen
Update userGuide.t2t
78bb691 
Fixed description for items in the "Reporting location and other information"
Qchristensen and others added 5 commits July 22, 2022 11:00
@Qchristensen @seanbudd
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>
@Qchristensen @seanbudd
Update user_docs/en/userGuide.t2t
5ca00b9 
Thanks!

Co-authored-by: Sean Budd <sean@nvaccess.org>
@Qchristensen @seanbudd
Update user_docs/en/userGuide.t2t
b9d56ca 
Co-authored-by: Sean Budd <sean@nvaccess.org>
@Qchristensen @seanbudd
Update user_docs/en/userGuide.t2t
75d0eb1 
Co-authored-by: Sean Budd <sean@nvaccess.org>
@Qchristensen @seanbudd
Update user_docs/en/userGuide.t2t
9b756ae 
Co-authored-by: Sean Budd <sean@nvaccess.org>
@Qchristensen
Copy link
Member Author

Thanks @seanbudd for picking up those formatting issues!

@Qchristensen @seanbudd
Update user_docs/en/userGuide.t2t
ff526cf 
Co-authored-by: Sean Budd <sean@nvaccess.org>
@seanbudd seanbudd self-assigned this Jul 22, 2022
@Qchristensen
Update userGuide.t2t
8423531 
Changed single ` for double ``
@seanbudd seanbudd marked this pull request as draft July 25, 2022 05:33
@seanbudd seanbudd added this to the 2022.4 milestone Jul 25, 2022
@Qchristensen @seanbudd
Update user_docs/en/userGuide.t2t
c2fadb6 
Co-authored-by: Sean Budd <sean@nvaccess.org>
@seanbudd seanbudd marked this pull request as ready for review August 1, 2022 06:44
seanbudd
seanbudd reviewed Aug 2, 2022
View reviewed changes
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
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 marked this pull request as draft August 2, 2022 01:13
@seanbudd
Copy link
Member

seanbudd commented Aug 2, 2022 •
edited
Loading

I would suggest checking the build output.

You can do this by:

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

seanbudd
seanbudd reviewed Aug 2, 2022
View reviewed changes
user_docs/en/userGuide.t2t Outdated Show resolved Hide resolved
Qchristensen and others added 4 commits August 2, 2022 12:02
@Qchristensen @seanbudd
Update user_docs/en/userGuide.t2t
ce97fc9 
Co-authored-by: Sean Budd <sean@nvaccess.org>
@Qchristensen @seanbudd
Update user_docs/en/userGuide.t2t
c92b80d 
Co-authored-by: Sean Budd <sean@nvaccess.org>
@Qchristensen @seanbudd
Update user_docs/en/userGuide.t2t
dd80e62 
Co-authored-by: Sean Budd <sean@nvaccess.org>
@Qchristensen @seanbudd
Update user_docs/en/userGuide.t2t
165e0ac 
Co-authored-by: Sean Budd <sean@nvaccess.org>
@AppVeyorBot
Copy link

See test results for failed build of commit 06cb14c351

Qchristensen and others added 9 commits August 4, 2022 12:10
@Qchristensen
Fix formatting of Quick Start Guide
bbc6656 
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!
@Qchristensen @seanbudd
Update user_docs/en/userGuide.t2t
1288001 
Co-authored-by: Sean Budd <sean@nvaccess.org>
@Qchristensen @seanbudd
Update user_docs/en/userGuide.t2t
a5c0831 
Co-authored-by: Sean Budd <sean@nvaccess.org>
@Qchristensen
Update formatting of user guide
45ef536 
Removed several tabs in lists, and changed keystrokes to single word, camel case (eg "down arrow" to "downArrow")
@Qchristensen @seanbudd
Update user_docs/en/userGuide.t2t
a85896d 
Co-authored-by: Sean Budd <sean@nvaccess.org>
@Qchristensen
Update userGuide.t2t
2c488bc 
Fixed several links missing #
@Qchristensen
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".
@Qchristensen
Update userGuide.t2t
e1936a4 
Fix table headings I had a semi-colon on which broke the heading.
@Qchristensen
Update userGuide.t2t
a9c41db 
Fixed step numbering in 2.2.2 Steps for installing NVDA.
Fixed heading for 2.3.8 web navigation
seanbudd
seanbudd reviewed Aug 8, 2022
View reviewed changes
Copy link
Member

@seanbudd seanbudd left a comment •
edited
Loading

Choose a reason for hiding this comment

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

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.

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 Show resolved Hide resolved
user_docs/en/userGuide.t2t Outdated Show resolved Hide resolved
@seanbudd seanbudd marked this pull request as ready for review August 8, 2022 05:57
feerrenrut
feerrenrut approved these changes Aug 8, 2022
View reviewed changes
Copy link
Contributor

@feerrenrut feerrenrut left a comment

Choose a reason for hiding this comment

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

Content looks good. Good work!

seanbudd
seanbudd approved these changes Aug 9, 2022
View reviewed changes
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.

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

@AppVeyorBot
Copy link

See test results for failed build of commit 3f8b5875e6

@seanbudd seanbudd merged commit a103ef1 into master Aug 9, 2022
@seanbudd 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
@seanbudd
update changes for #13934
6509042 
The changes for #13934 were accidentally forgotton
@seanbudd seanbudd mentioned this pull request Aug 9, 2022
Merged
seanbudd added a commit that referenced this pull request Aug 10, 2022
@seanbudd
update changes for #13934 (#13998)
1751403 
The changes for #13934 were accidentally forgotton
@seanbudd seanbudd mentioned this pull request May 24, 2024
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@lukaszgo1 lukaszgo1 lukaszgo1 left review comments

@seanbudd seanbudd seanbudd approved these changes

@feerrenrut feerrenrut feerrenrut approved these changes

Assignees

@feerrenrut feerrenrut

@seanbudd seanbudd

@Qchristensen Qchristensen

Labels
None yet
Projects
None yet
Milestone
2022.4
Development

Successfully merging this pull request may close these issues.
5 participants
@Qchristensen @AppVeyorBot @seanbudd @feerrenrut @lukaszgo1