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

chore: update reference documentation linked from readme. #2351

Merged
merged 4 commits into from
Nov 15, 2023
Merged

Conversation

zhumin8
Copy link
Contributor

@zhumin8 zhumin8 commented Nov 14, 2023

As part of #2101, update reference documentation links in README to reflect current. Deleted 2.0.11 ref doc links as it's already out of support.
Added tag to allow auto update for the latest 4.x version ref doc and javadoc. However, for 3.x versions, manual update is still needed.
One option is to delete 3.x ref doc links from README.md in main branch and keep it in 3.x branch, so each can be auto-updated as part of release. What do you think?

@zhumin8 zhumin8 marked this pull request as ready for review November 14, 2023 18:34
@zhumin8 zhumin8 requested a review from a team as a code owner November 14, 2023 18:34
Copy link

Kudos, SonarCloud Quality Gate passed!    Quality Gate passed

Bug A 0 Bugs
Vulnerability A 0 Vulnerabilities
Security Hotspot A 0 Security Hotspots
Code Smell A 0 Code Smells

No Coverage information No Coverage information
No Duplication information No Duplication information

@zhumin8 zhumin8 merged commit e3579d4 into main Nov 15, 2023
52 checks passed
@zhumin8 zhumin8 deleted the update-readme branch November 15, 2023 14:21
zhumin8 added a commit that referenced this pull request Nov 15, 2023
As part of #2101, update reference documentation links in README to reflect current. Deleted 2.0.11 ref doc links as it's already out of support.
Added tag to allow auto update for the latest 4.x version ref doc and javadoc. However, for 3.x versions, manual update is still needed.
zhumin8 added a commit that referenced this pull request Nov 16, 2023
Backport #2351 to 3.x branch README.md.

Also remove 4.x version ref doc links from this page.
@JoeWang1127 JoeWang1127 linked an issue Nov 27, 2023 that may be closed by this pull request
3 tasks
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.

Reference docs version update issues
2 participants