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

feat: reference page jump with version #456

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
f9000d0
feat: reference jump with version
urfreespace Mar 6, 2023
9141cf4
update
urfreespace Mar 6, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions scripts/replace.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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

/pulsar:binary_release_url/g,
/pulsar:connector_release_url/g,
/pulsar:offloader_release_url/g,
Expand Down Expand Up @@ -198,6 +199,7 @@ const options = {
files: [`${nextDocsDir}/*.md`, `${nextDocsDir}/**/*.md`],
from: from,
to: [
`${latestVersion}`,
`${latestVersion}`,
`${latestVersion}`,
binaryReleaseUrl(`${latestVersion}`),
Expand Down Expand Up @@ -247,6 +249,7 @@ for (let _v of versions) {
to: [
`${vWithoutIncubating}`,
`${v}`,
`${_v}`,
binaryReleaseUrl(`${v}`),
connectorReleaseUrl(`${v}`),
offloaderReleaseUrl(`${v}`),
Expand Down