Skip to content
New issue

Have a question about this project? # for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “#”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? # to your account

feat: reference page jump with version #456

Merged
merged 2 commits into from
Mar 7, 2023
Merged

Conversation

urfreespace
Copy link
Member

issue: apache/pulsar#19676

Documentation

  • doc
  • doc-required
  • doc-not-needed
  • doc-complete

Signed-off-by: Li Li <urfree@apache.org>
@@ -164,6 +164,7 @@ const latestVersion = getRealVersion(latestMajorRelease);
const from = [
/@pulsar:version_number@/g,
/@pulsar:version@/g,
/@pulsar:version_origin@/g,
Copy link
Member

Choose a reason for hiding this comment

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

I'm afraid that such variable cannot resolve 2.6~2.7 versioned docs to 2.6.x and 2.7.x properly. But if we change only for new versions, it can be reasonable.

Copy link
Member Author

Choose a reason for hiding this comment

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

yes, @momo-jun said only update the versions begin with 2.8.x

Copy link
Contributor

Choose a reason for hiding this comment

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

@tisonkun It's acceptable, IMO, because we no longer actively improve the docs of those versions.
I will update the occurrences of links to the reference site in 2.8.x docs and later versions as soon as this PR can be merged.

Copy link
Member

Choose a reason for hiding this comment

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

Make sense. Although, this patch update for NEXT version only. @urfreespace would you update for 2.8.x, 2.9.x, 2.10.x and 2.11.x?

Copy link
Member Author

Choose a reason for hiding this comment

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

yeah, you are right, I just keep the script update and removed the update for next version, and @momo-jun will make another PR to update the docs, PTAL

Signed-off-by: Li Li <urfree@apache.org>
Copy link
Member

@tisonkun tisonkun left a comment

Choose a reason for hiding this comment

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

It seems we don't touch any effective docs content now.

@urfreespace
Copy link
Member Author

It seems we don't touch any effective docs content now.

@momo-jun will submit other PR to update the docs

@urfreespace urfreespace merged commit 1d0b37f into main Mar 7, 2023
@urfreespace
Copy link
Member Author

@tisonkun @momo-jun I commit a PR to update reference link for version 2.11.x #458 @momo-jun you can update other version docs of the rest

# for free to join this conversation on GitHub. Already have an account? # to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants