Fixes some links in the dev guide by XLTechie · Pull Request #14633 · nvaccess/nvda

XLTechie · 2023-02-13T08:28:47Z

Link to issue number:

Corrects the exact problem mentioned in #14632, but may not solve it ultimately in the desired way. See the known issues section below. This is both a stop-gap while the ultimate solution is decided, and fixes some moderate errors found while working on it.

Summary of the issue:

The link to the NVDA Helper README in the Development Guide did not work.

Description of user facing changes

Fixed that link per suggested alternative given by @michaelDCurran in #14632 (comment).

While doing that, I noticed and fixed:

A couple links to the Translating NVDA wiki page, which had no link markup at all.
One case of a link which was written in markdown style instead of T2T style.

Description of development approach

Searched file for the helper readme reference, and replaced the broken file reference with the link given by @michaelDCurran .
Searched for other occurrences of "http", and verified that they were all in validly formatted link markup, and fixed them where found not to be.

Testing strategy:

Checked links generated in PR build. All changed links are clickable, and go to the expected destinations.

Known issues with pull request:

This PR does not address @michaelDCurran's suggestion in this comment.

Change log entries:

None needed.

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
Security precautions taken.

… was written in Markdown instead of T2T.

… wiki page were not previously styled as clickable links.

Brian1Gaff · 2023-02-13T09:17:51Z

Comment: The fact that nobody has mentioned this until now would perhaps indicate this is not the way those interested access the guide. Brian

…

-- ***@***.*** Sent via blueyonder.(Virgin media) Please address personal E-mail to:- ***@***.***, putting 'Brian Gaff' in the display name field. ----- Original Message ----- From: "Luke Davis" ***@***.***> To: "nvaccess/nvda" ***@***.***> Cc: "Subscribed" ***@***.***>

Sent: Monday, February 13, 2023 8:29 AM Subject: [nvaccess/nvda] Fixes some links in the dev guide (PR #14633) ### Link to issue number: Fixes #14632 ### Summary of the issue: The link to the NVDA Helper README in the Development Guide did not work. ### Description of user facing changes Fixed that link per suggested alternative given by @michaelDCurran in [#14632 (comment)](#14632 (comment)). While doing that, I noticed and fixed: * A couple links to the Translating NVDA wiki page, which had no link markup at all. * One case of a link which was written in markdown style instead of T2T style. ### Description of development approach * Searched file for the helper readme reference, and replaced the broken file reference with the link given by @michaelDCurran . * Searched for other occurrences of "http", and verified that they were all in validly formatted link markup, and fixed them where found not to be. ### Testing strategy: None; will wait for build and check links in result. Will update if any broken. ### Known issues with pull request: This PR does not address @michaelDCurran's suggestion in [this comment](#14632 (comment)). ### Change log entries: None needed. ### Code Review Checklist: - [X] Pull Request description: - description is up to date - change log entries - [X] Testing: - Unit tests - System (end to end) tests - Manual testing - [X] API is compatible with existing add-ons. - [X] Documentation: - User Documentation - Developer / Technical Documentation - Context sensitive help for GUI changes - [X] UX of all users considered: - Speech - Braille - Low Vision - Different web browsers - Localization in other languages / culture than English - [X] Security precautions taken. You can view, comment on, or merge this pull request online at: #14633 -- Commit Summary -- * Fixed broken NVDA Helper Readme link in devDocs/developerGuide.t2t. * Fixed a link to the changes file in devDocs/developerGuide.t2t, which was written in Markdown instead of T2T. * In devDocs/developerGuide.t2t, a couple links to the Translating NVDA wiki page were not previously styled as clickable links. -- File Changes -- M devDocs/developerGuide.t2t (9) -- Patch Links -- https://github.com/nvaccess/nvda/pull/14633.patch https://github.com/nvaccess/nvda/pull/14633.diff -- Reply to this email directly or view it on GitHub: #14633 You are receiving this because you are subscribed to this thread. Message ID: ***@***.***>

AppVeyorBot · 2023-02-13T09:36:49Z

PASS: Translation comments check.
PASS: Unit tests.
PASS: Lint check.
FAIL: System tests (tags: installer NVDA). See test results for more information.
Build (for testing PR): https://ci.appveyor.com/api/buildjobs/urcjaxafs8wpfs9n/artifacts/output/nvda_snapshot_pr14633-27671,14e9d76b.exe
CI timing (mins):
INIT 0.0,
INSTALL_START 0.8,
INSTALL_END 0.9,
BUILD_START 0.0,
BUILD_END 23.5,
TESTSETUP_START 0.0,
TESTSETUP_END 0.3,
TEST_START 0.0,
TEST_END 20.1,
FINISH_END 0.2

See test results for failed build of commit 14e9d76b94

XLTechie · 2023-02-13T10:55:10Z

@Brian1Gaff it is more likely that few people access the development guide at all (the ratio of developers to users), and that, of those, there are relatively few who need to follow the link to the C-related code (as opposed to those who are there to read about developing in the Python portions of NVDA). Of that subset of a subset of the set of NVDA users, most who need to know about the linked file, likely know, or can easily figure out, where else to get it.
Same for the translation wiki entries I fixed, or the link to the changes file I linked. You don't come to this document to find the changes file link--you already have that file.
I did, in fact, notice that last before now, it just wasn't important enough to care about, since it would be highly improbable that anyone reading this guide, needed this guide in order to find the changes file.

AppVeyorBot · 2023-02-13T11:43:31Z

PASS: Translation comments check.
PASS: Unit tests.
PASS: Lint check.
FAIL: System tests (tags: installer NVDA). See test results for more information.
Build (for testing PR): https://ci.appveyor.com/api/buildjobs/s3qox7npxg1uvp7c/artifacts/output/nvda_snapshot_pr14633-27672,865280a8.exe
CI timing (mins):
INIT 0.0,
INSTALL_START 0.9,
INSTALL_END 0.9,
BUILD_START 0.0,
BUILD_END 22.9,
TESTSETUP_START 0.0,
TESTSETUP_END 0.3,
TEST_START 0.0,
TEST_END 22.6,
FINISH_END 0.3

See test results for failed build of commit 865280a82e

Follow up to #14633 Summary of the issue: The internal link to the nvdaHelper readme was removed from the developerGuide in favour of a static link to the GitHub repository in #14633 The relevant code in the sconscript for the developerGuide can be safely removed.

Luke Davis added 3 commits February 13, 2023 03:10

Fixed broken NVDA Helper Readme link in devDocs/developerGuide.t2t.

f39a085

Fixed a link to the changes file in devDocs/developerGuide.t2t, which…

4cf44bc

… was written in Markdown instead of T2T.

In devDocs/developerGuide.t2t, a couple links to the Translating NVDA…

b4e973c

… wiki page were not previously styled as clickable links.

XLTechie marked this pull request as ready for review February 13, 2023 08:31

XLTechie requested a review from a team as a code owner February 13, 2023 08:31

XLTechie requested a review from michaelDCurran February 13, 2023 08:31

XLTechie closed this Feb 13, 2023

XLTechie reopened this Feb 13, 2023

seanbudd approved these changes Feb 13, 2023

View reviewed changes

seanbudd merged commit e86614f into nvaccess:master Feb 14, 2023

nvaccessAuto added this to the 2023.2 milestone Feb 14, 2023

seanbudd mentioned this pull request Sep 4, 2023

Remove nvdaHelper readme from devDocs sconscript #15359

Merged

XLTechie deleted the fix14632 branch April 7, 2024 02:20

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Fixes some links in the dev guide#14633

Fixes some links in the dev guide#14633
seanbudd merged 3 commits into
nvaccess:masterfrom
XLTechie:fix14632

XLTechie commented Feb 13, 2023 •

edited

Loading

Uh oh!

Brian1Gaff commented Feb 13, 2023 via email

Uh oh!

AppVeyorBot commented Feb 13, 2023

Uh oh!

XLTechie commented Feb 13, 2023

Uh oh!

AppVeyorBot commented Feb 13, 2023

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

Uh oh!

Conversation

XLTechie commented Feb 13, 2023 • edited 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!

Brian1Gaff commented Feb 13, 2023 via email

Uh oh!

AppVeyorBot commented Feb 13, 2023

Uh oh!

XLTechie commented Feb 13, 2023

Uh oh!

AppVeyorBot commented Feb 13, 2023

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

XLTechie commented Feb 13, 2023 •

edited

Loading