Skip to content

Add Documentation of the AppVeyor build process for NVDA forks#16293

Merged
michaelDCurran merged 5 commits into
nvaccess:masterfrom
XLTechie:fixAppveyorHow-To
Apr 1, 2024
Merged

Add Documentation of the AppVeyor build process for NVDA forks#16293
michaelDCurran merged 5 commits into
nvaccess:masterfrom
XLTechie:fixAppveyorHow-To

Conversation

@XLTechie

@XLTechie XLTechie commented Mar 12, 2024

Copy link
Copy Markdown
Collaborator

Link to issue number:

Follow-up of #16221

Summary of the issue:

The streamlined AppVeyor build process implemented in #16221, requires documentation in order to be useful.

Description of user facing changes

None.

Description of development approach

  • Wrote a document in projectDocs/dev/buildingNVDAOnAppVeyor.md.
  • Added references in readme.md and contributing.md, at @seanbudd's suggestion.
  • Took the liberty of adding a missing lead heading in buildingNVDA.md.

Testing strategy:

Checked all links to be working as of now.
Tested all commands.
I've been using variations of this process for three years.

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

Comment thread projectDocs/dev/buildingNVDAOnAppveyor.md Outdated
@AppVeyorBot

Copy link
Copy Markdown

See test results for failed build of commit 845802bcb7

@XLTechie XLTechie marked this pull request as ready for review March 13, 2024 00:55
@XLTechie XLTechie requested a review from a team as a code owner March 13, 2024 00:55
@XLTechie XLTechie requested a review from gerald-hartig March 13, 2024 00:55
@XLTechie

Copy link
Copy Markdown
Collaborator Author

CC @Qchristensen
Don't know if you also review dev docs, but if so ...

@seanbudd seanbudd left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

generally looks good. I would suggest changing Appveyor to AppVeyor across this diff

Comment thread user_docs/en/changes.t2t Outdated
Comment thread projectDocs/dev/readme.md Outdated
Comment thread projectDocs/dev/contributing.md Outdated
Comment thread projectDocs/dev/buildingNVDAOnAppveyor.md
*(FixMe: more instructions may be needed here.)*
4. Move to the "Select repository for your new project" heading, and then to the heading representing your GitHub username.
5. Below that heading, you should find your GitHub repositories listed. Go to the one representing your NVDA fork.
6. This part is less than perfectly accessible via the usual methods: you will need to use NVDA+numpad divide, to route the mouse to the repository name, and then numpad divide to click on it.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Suggested change
6. This part is less than perfectly accessible via the usual methods: you will need to use NVDA+numpad divide, to route the mouse to the repository name, and then numpad divide to click on it.
6. This part is less than perfectly accessible via the usual methods: you will need to use `NVDA+numpad` divide, to route the mouse to the repository name, and then `numpadDivide` to click on it.

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

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

"Divide" falls outside of the backticks in your suggestion. I have modified the spacing and casing to reach your intended outcome.

Suggested change
6. This part is less than perfectly accessible via the usual methods: you will need to use NVDA+numpad divide, to route the mouse to the repository name, and then numpad divide to click on it.
6. This part is less than perfectly accessible via the usual methods: you will need to use `NVDA+NumpadDivide`, to route the mouse to the repository name, and then `NumpadDivide` to click on it.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Key commands should be written in lowerCamelCase

https://github.com/nvaccess/nvda/blob/master/projectDocs/dev/userGuideStandards.md#general-standards

The casing should be numpadDivide

Comment thread projectDocs/dev/buildingNVDAOnAppveyor.md Outdated
@seanbudd seanbudd marked this pull request as draft March 15, 2024 02:49
@XLTechie

This comment was marked as outdated.

@XLTechie XLTechie changed the title Add Documentation of the Appveyor build process for NVDA forks Add Documentation of the AppVeyor build process for NVDA forks Mar 15, 2024
@seanbudd seanbudd marked this pull request as ready for review March 15, 2024 05:50
@seanbudd

Copy link
Copy Markdown
Member

Just for future reference, it would have been better to keep the original commit. Commit messages don't matter much, and as it was a force push the PR has to be re-reviewed from scratch, rather than from the previous review

@XLTechie

XLTechie commented Mar 15, 2024 via email

Copy link
Copy Markdown
Collaborator Author

@XLTechie

XLTechie commented Mar 15, 2024 via email

Copy link
Copy Markdown
Collaborator Author

@michaelDCurran michaelDCurran merged commit f67d317 into nvaccess:master Apr 1, 2024
@nvaccessAuto nvaccessAuto added this to the 2024.2 milestone Apr 1, 2024
seanbudd added a commit that referenced this pull request May 10, 2024
Fixes #16512
Fixup of #16293

Summary of the issue:
Links to the document for building NVDA on appveyor had a typo
add reference to priorities for devs
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

6 participants