Skip to content

Reference API mailing list and improve docs for deprecations#13999

Merged
seanbudd merged 8 commits into
masterfrom
addDeprecationAndMailingListDocs
Aug 19, 2022
Merged

Reference API mailing list and improve docs for deprecations#13999
seanbudd merged 8 commits into
masterfrom
addDeprecationAndMailingListDocs

Conversation

@seanbudd

@seanbudd seanbudd commented Aug 9, 2022

Copy link
Copy Markdown
Member

Reference the new NVDA API announcements mailing list in the developer guide and the change log.

Adds notes to the developer guide on the NVDA deprecation, removal and addition process.

Updated the deprecations.md doc to include new deprecation processes.

After merging:

@seanbudd seanbudd requested a review from a team as a code owner August 9, 2022 07:14
@seanbudd seanbudd requested a review from feerrenrut August 9, 2022 07:14
@CyrilleB79

Copy link
Copy Markdown
Contributor

I do not know if it is in the scope of this PR or not. But I have realized while translating the changes log for 2022.3 that we will end up for each release with the following paragraph:

These are proposed API breaking changes.
The deprecated part of the API will continue to be available until the specified release.
If no release is specified, the plan for removal has not been determined.
Note, the roadmap for removals is 'best effort' and may be subject to change.
Please test the new API and provide feedback.
For add-on authors, please open a GitHub issue if these changes stop the API from meeting your needs.

Can we change the process to avoid repeating this information all along the change log?

  1. This would avoid redundancy in the log
  2. In case this paragraph changes just a bit, there is a chance that readers and/or translators do not notice that something has changed because the details of this paragraph will not be read anymore.

@seanbudd

seanbudd commented Aug 10, 2022

Copy link
Copy Markdown
Member Author

@CyrilleB79 - I think it could be considered in scope.

The large block of text could go inside the developerGuide instead.
the change log does not need to contain this information.

@seanbudd seanbudd marked this pull request as draft August 10, 2022 02:27
@seanbudd seanbudd marked this pull request as ready for review August 10, 2022 07:11
@AppVeyorBot

Copy link
Copy Markdown

See test results for failed build of commit e704e084c5

Comment thread user_docs/en/changes.t2t
Comment thread devDocs/developerGuide.t2t Outdated
Comment thread user_docs/en/changes.t2t
Comment thread devDocs/developerGuide.t2t
@seanbudd seanbudd requested a review from feerrenrut August 17, 2022 05:36
@AppVeyorBot

Copy link
Copy Markdown

See test results for failed build of commit 9f433ed717

Comment thread devDocs/developerGuide.t2t Outdated
Comment thread devDocs/developerGuide.t2t Outdated
@seanbudd seanbudd requested a review from feerrenrut August 19, 2022 00:46
@seanbudd seanbudd merged commit f47eb66 into master Aug 19, 2022
@seanbudd seanbudd deleted the addDeprecationAndMailingListDocs branch August 19, 2022 02:28
@nvaccessAuto nvaccessAuto added this to the 2022.4 milestone Aug 19, 2022
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.

5 participants