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 #16553

Merged
merged 8 commits into from
May 24, 2024

Conversation

Qchristensen
Copy link
Member

@Qchristensen Qchristensen commented May 15, 2024

Updated #16486 against md file rather than t2t file.

Link to issue number:

Closed #16399

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:

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.

@Qchristensen
Copy link
Member Author

Note line 287 about verifying add-ons prior to installation refers to the "Installing add-ons" section of the user guide and anticipates that either #16316 or #16510 will be implemented in the same release.

user_docs/en/userGuide.md Outdated Show resolved Hide resolved
user_docs/en/userGuide.md Outdated Show resolved Hide resolved
user_docs/en/userGuide.md Outdated Show resolved Hide resolved
user_docs/en/userGuide.md Outdated Show resolved Hide resolved
user_docs/en/userGuide.md Outdated Show resolved Hide resolved
user_docs/en/userGuide.md Outdated Show resolved Hide resolved
user_docs/en/userGuide.md Outdated Show resolved Hide resolved
user_docs/en/userGuide.md Outdated Show resolved Hide resolved
user_docs/en/userGuide.md Outdated Show resolved Hide resolved
user_docs/en/userGuide.md Outdated Show resolved Hide resolved
@seanbudd seanbudd changed the title Add section on add-on store to the Quick Start Guide in the User Guide (PR against MD rather than T2T file) Add section on add-on store to the Quick Start Guide in the User Guide May 20, 2024
@seanbudd seanbudd added the conceptApproved Similar 'triaged' for issues, PR accepted in theory, implementation needs review. label May 20, 2024
user_docs/en/userGuide.md Outdated Show resolved Hide resolved
seanbudd
seanbudd previously approved these changes May 24, 2024
@Qchristensen Qchristensen marked this pull request as ready for review May 24, 2024 00:11
@Qchristensen Qchristensen requested a review from a team as a code owner May 24, 2024 00:11
@seanbudd seanbudd changed the base branch from master to beta May 24, 2024 00:54
@seanbudd seanbudd dismissed their stale review May 24, 2024 00:54

The base branch was changed.

@seanbudd seanbudd requested a review from a team as a code owner May 24, 2024 00:54
@seanbudd seanbudd requested review from seanbudd and removed request for a team May 24, 2024 00:54
@seanbudd seanbudd changed the base branch from beta to master May 24, 2024 00:54
@seanbudd seanbudd force-pushed the QuickStartAddons branch from 362285d to 26ac5e1 Compare May 24, 2024 00:59
@seanbudd seanbudd changed the base branch from master to beta May 24, 2024 00:59
@seanbudd seanbudd merged commit e8317ca into beta May 24, 2024
1 of 2 checks passed
@seanbudd seanbudd deleted the QuickStartAddons branch May 24, 2024 00:59
@seanbudd seanbudd added this to the 2024.2 milestone May 24, 2024
@CyrilleB79
Copy link
Collaborator

One translator has noticed that in this PR, there are no blank line after the headings, on contrary to the rest of the User Guide. This does not seem to cause any change.

@Qchristensen or @seanbudd, could you confirm that the presence or not of blank lines after headings in .md files have no impact? Thanks.

@seanbudd
Copy link
Member

as far as I am aware, these blank lines have no impact in markdown. this can be checked by ensuring the header and following paragraph text builds correctly to HTML

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.

3 participants