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

DOC-2174: added documentation for Mentions plugin's getUsers API deprecation to 6.0-release-notes-premium-changes.adoc and migration-from-5x.adoc #3060

Merged
merged 8 commits into from
Feb 13, 2024

Conversation

FarzadHayat
Copy link
Contributor

@FarzadHayat FarzadHayat commented Feb 8, 2024

Ticket: DOC-2174, getUsers API deprecation in v6 not documented.

Changes:

  • added getusers-api-alternative demo to 6.0 release notes and the 5 to 6 migration guide

Pre-checks:

  • Branch prefixed with feature/6/ or hotfix/6/
  • Changelog entry added
  • Files has been included where required (if applicable)

Review:

  • Documentation Team Lead has reviewed

@FarzadHayat FarzadHayat changed the base branch from staging/docs-6 to release/docs-6 February 8, 2024 06:27
@FarzadHayat FarzadHayat changed the title DOC-2174: added documentation for Mentions plugin's getUsers API deprecation DOC-2174: added documentation for Mentions plugin's getUsers API deprecation to 6.0-release-notes-premium-changes.adoc and migration-from-5x.adoc Feb 8, 2024
@FarzadHayat
Copy link
Contributor Author

Just thought I would put up a first draft, open to suggestions!
Feel free to provide your thoughts if you think the changes could be structured better.

Some questions regarding the demo for reviewers:

  • are you happy with the inclusion of the interactive example inside 6.0-release-notes-premium-changes.adoc?
  • currently, if a viewer switches away from the demo to the HTML or JS tab, the editor will restart and lose the current list of users which is confusing. what are your thoughts about modifying the custom getUsers function to include all mentions in the document rather than just ones in the current editor session?

changelog.md Outdated Show resolved Hide resolved
@FarzadHayat FarzadHayat marked this pull request as ready for review February 9, 2024 01:04
@FarzadHayat FarzadHayat requested a review from a team as a code owner February 9, 2024 01:04
Copy link
Contributor

@kemister85 kemister85 left a comment

Choose a reason for hiding this comment

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

@FarzadHayat Well done, i think this is a good improvement as discussed.

changelog.md Outdated Show resolved Hide resolved
@FarzadHayat FarzadHayat merged commit b7f158c into release/docs-6 Feb 13, 2024
5 checks passed
@FarzadHayat FarzadHayat deleted the hotfix/6/DOC-2174 branch February 13, 2024 00:44
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.

3 participants