You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@pulsar.apache.org by "momo-jun (via GitHub)" <gi...@apache.org> on 2023/03/07 09:36:59 UTC
[GitHub] [pulsar-site] momo-jun opened a new pull request, #459: [improve][doc] Improve the links to reference docs with versions and anchors
momo-jun opened a new pull request, #459:
URL: https://github.com/apache/pulsar-site/pull/459
Fixes https://github.com/apache/pulsar/issues/19676.
### Modifications
1. replace the existing links https://pulsar.apache.org/tools/ with https://pulsar.apache.org/reference/.
2. add a version variable to version-specific links to redirect with the expected doc version.
3. add a query string in those links pointing to a specific command to redirect with an anchored position.
4. minor fixes, such as removing the extra `/docs/next/` from several links.
### Documentation
<!-- DO NOT REMOVE THIS SECTION. CHECK THE PROPER BOX ONLY. -->
- [x] `doc` <!-- Your PR contains doc changes. Please attach the local preview screenshots (run `./preview.sh` at root path) to your PR description, or else your PR might not get merged. -->
- [ ] `doc-required` <!-- Your PR changes impact docs and you will update later -->
- [ ] `doc-not-needed` <!-- Your PR changes do not impact docs -->
- [ ] `doc-complete` <!-- Docs have been already added -->
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@pulsar.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [pulsar-site] momo-jun commented on a diff in pull request #459: [improve][doc] Improve the links to reference docs with versions and anchors
Posted by "momo-jun (via GitHub)" <gi...@apache.org>.
momo-jun commented on code in PR #459:
URL: https://github.com/apache/pulsar-site/pull/459#discussion_r1127690475
##########
docs/admin-api-brokers.md:
##########
@@ -14,7 +14,7 @@ import TabItem from '@theme/TabItem';
This page only shows **some frequently used operations**.
- - For the latest and complete information about `Pulsar admin`, including commands, flags, descriptions, and more information, see [Pulsar admin doc](/tools/pulsar-admin/).
+ - For the latest and complete information about `Pulsar admin`, including commands, flags, descriptions, and more information, see [Pulsar admin doc](https://pulsar.apache.org/reference/#/@pulsar:version_origin@/pulsar-admin/).
Review Comment:
Good to know that. I can update them as long as the logic is stable:) Does it also apply to REST API links like `https://pulsar.apache.org/admin-rest-api/?version=@pulsar:version_number@`?
And do you know whether the built-in link checker can cover broken internal links like this?
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@pulsar.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [pulsar-site] tisonkun commented on a diff in pull request #459: [improve][doc] Improve the links to reference docs with versions and anchors
Posted by "tisonkun (via GitHub)" <gi...@apache.org>.
tisonkun commented on code in PR #459:
URL: https://github.com/apache/pulsar-site/pull/459#discussion_r1129186361
##########
docs/about.md:
##########
@@ -25,12 +25,12 @@ Select one of the content blocks below to begin your Pulsar journey. If you ...
* An experienced Pulsar coder looking for API, metrics, or configuration documentation, go to **Reference**.
<BlockLinks>
- <BlockLink title="About Pulsar" url="/docs/next/concepts-overview/" />
- <BlockLink title="Get Started" url="/docs/next/getting-started-home/" />
- <BlockLink title="Install, Deploy, Upgrade" url="/docs/next/install-deploy-upgrade-landing/" />
- <BlockLink title="Pulsar for Developers" url="/docs/next/developers-landing/" />
- <BlockLink title="How To" url="/docs/next/how-to-landing/" />
- <BlockLink title="Reference" url="/docs/next/reference-landing/" />
+ <BlockLink title="About Pulsar" url="concepts-overview" />
+ <BlockLink title="Get Started" url="/docs/next/getting-started-home" />
+ <BlockLink title="Install, Deploy, Upgrade" url="/docs/next/install-deploy-upgrade-landing" />
+ <BlockLink title="Pulsar for Developers" url="/docs/next/developers-landing" />
+ <BlockLink title="How To" url="/docs/next/how-to-landing" />
Review Comment:
Shall we apply the relative path for these tags consistently also?
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@pulsar.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [pulsar-site] tisonkun commented on a diff in pull request #459: [improve][doc] Improve the links to reference docs with versions and anchors
Posted by "tisonkun (via GitHub)" <gi...@apache.org>.
tisonkun commented on code in PR #459:
URL: https://github.com/apache/pulsar-site/pull/459#discussion_r1127616340
##########
docs/admin-api-brokers.md:
##########
@@ -14,7 +14,7 @@ import TabItem from '@theme/TabItem';
This page only shows **some frequently used operations**.
- - For the latest and complete information about `Pulsar admin`, including commands, flags, descriptions, and more information, see [Pulsar admin doc](/tools/pulsar-admin/).
+ - For the latest and complete information about `Pulsar admin`, including commands, flags, descriptions, and more information, see [Pulsar admin doc](https://pulsar.apache.org/reference/#/@pulsar:version_origin@/pulsar-admin/).
Review Comment:
I'd suggest use `/reference/...` or `pathname:///reference` so that we can locally debug (instead of always link to the online version).
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@pulsar.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [pulsar-site] momo-jun commented on a diff in pull request #459: [improve][doc] Improve the links to reference docs with versions and anchors
Posted by "momo-jun (via GitHub)" <gi...@apache.org>.
momo-jun commented on code in PR #459:
URL: https://github.com/apache/pulsar-site/pull/459#discussion_r1129060044
##########
docs/admin-api-brokers.md:
##########
@@ -14,7 +14,7 @@ import TabItem from '@theme/TabItem';
This page only shows **some frequently used operations**.
- - For the latest and complete information about `Pulsar admin`, including commands, flags, descriptions, and more information, see [Pulsar admin doc](/tools/pulsar-admin/).
+ - For the latest and complete information about `Pulsar admin`, including commands, flags, descriptions, and more information, see [Pulsar admin doc](https://pulsar.apache.org/reference/#/@pulsar:version_origin@/pulsar-admin/).
Review Comment:
I've applied this change to more occurrences containing `https://pulsar.apache.org/`, such as `/download/`, `/api/admin/`, `/swagger/` and `/admin-rest-api/`.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@pulsar.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [pulsar-site] tisonkun commented on a diff in pull request #459: [improve][doc] Improve the links to reference docs with versions and anchors
Posted by "tisonkun (via GitHub)" <gi...@apache.org>.
tisonkun commented on code in PR #459:
URL: https://github.com/apache/pulsar-site/pull/459#discussion_r1128863942
##########
docs/admin-api-brokers.md:
##########
@@ -14,7 +14,7 @@ import TabItem from '@theme/TabItem';
This page only shows **some frequently used operations**.
- - For the latest and complete information about `Pulsar admin`, including commands, flags, descriptions, and more information, see [Pulsar admin doc](/tools/pulsar-admin/).
+ - For the latest and complete information about `Pulsar admin`, including commands, flags, descriptions, and more information, see [Pulsar admin doc](https://pulsar.apache.org/reference/#/@pulsar:version_origin@/pulsar-admin/).
Review Comment:
> Does it also apply to REST API links
Yes.
> whether the built-in link checker can cover broken internal links like this
I don't know. One case is that we may not bundle all static files, so it can produce false positives. But IIRC we bundle all recent versions.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@pulsar.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [pulsar-site] momo-jun commented on a diff in pull request #459: [improve][doc] Improve the links to reference docs with versions and anchors
Posted by "momo-jun (via GitHub)" <gi...@apache.org>.
momo-jun commented on code in PR #459:
URL: https://github.com/apache/pulsar-site/pull/459#discussion_r1127674758
##########
docs/admin-api-brokers.md:
##########
@@ -14,7 +14,7 @@ import TabItem from '@theme/TabItem';
This page only shows **some frequently used operations**.
- - For the latest and complete information about `Pulsar admin`, including commands, flags, descriptions, and more information, see [Pulsar admin doc](/tools/pulsar-admin/).
+ - For the latest and complete information about `Pulsar admin`, including commands, flags, descriptions, and more information, see [Pulsar admin doc](https://pulsar.apache.org/reference/#/@pulsar:version_origin@/pulsar-admin/).
Review Comment:
Did you mean that we can directly use `pathname://` to replace the domain prefix `https://pulsar.apache.org` for all these occurrences?
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@pulsar.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [pulsar-site] momo-jun commented on a diff in pull request #459: [improve][doc] Improve the links to reference docs with versions and anchors
Posted by "momo-jun (via GitHub)" <gi...@apache.org>.
momo-jun commented on code in PR #459:
URL: https://github.com/apache/pulsar-site/pull/459#discussion_r1129190832
##########
docs/about.md:
##########
@@ -25,12 +25,12 @@ Select one of the content blocks below to begin your Pulsar journey. If you ...
* An experienced Pulsar coder looking for API, metrics, or configuration documentation, go to **Reference**.
<BlockLinks>
- <BlockLink title="About Pulsar" url="/docs/next/concepts-overview/" />
- <BlockLink title="Get Started" url="/docs/next/getting-started-home/" />
- <BlockLink title="Install, Deploy, Upgrade" url="/docs/next/install-deploy-upgrade-landing/" />
- <BlockLink title="Pulsar for Developers" url="/docs/next/developers-landing/" />
- <BlockLink title="How To" url="/docs/next/how-to-landing/" />
- <BlockLink title="Reference" url="/docs/next/reference-landing/" />
+ <BlockLink title="About Pulsar" url="concepts-overview" />
+ <BlockLink title="Get Started" url="/docs/next/getting-started-home" />
+ <BlockLink title="Install, Deploy, Upgrade" url="/docs/next/install-deploy-upgrade-landing" />
+ <BlockLink title="Pulsar for Developers" url="/docs/next/developers-landing" />
+ <BlockLink title="How To" url="/docs/next/how-to-landing" />
Review Comment:
You are right! Thanks for finding out more occurrences that I missed.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@pulsar.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [pulsar-site] tisonkun commented on a diff in pull request #459: [improve][doc] Improve the links to reference docs with versions and anchors
Posted by "tisonkun (via GitHub)" <gi...@apache.org>.
tisonkun commented on code in PR #459:
URL: https://github.com/apache/pulsar-site/pull/459#discussion_r1128864472
##########
docs/admin-api-brokers.md:
##########
@@ -14,7 +14,7 @@ import TabItem from '@theme/TabItem';
This page only shows **some frequently used operations**.
- - For the latest and complete information about `Pulsar admin`, including commands, flags, descriptions, and more information, see [Pulsar admin doc](/tools/pulsar-admin/).
+ - For the latest and complete information about `Pulsar admin`, including commands, flags, descriptions, and more information, see [Pulsar admin doc](https://pulsar.apache.org/reference/#/@pulsar:version_origin@/pulsar-admin/).
Review Comment:
Said that for references, we bundle all pages: https://github.com/apache/pulsar-site/tree/main/static/reference
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@pulsar.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [pulsar-site] momo-jun commented on a diff in pull request #459: [improve][doc] Improve the links to reference docs with versions and anchors
Posted by "momo-jun (via GitHub)" <gi...@apache.org>.
momo-jun commented on code in PR #459:
URL: https://github.com/apache/pulsar-site/pull/459#discussion_r1127690475
##########
docs/admin-api-brokers.md:
##########
@@ -14,7 +14,7 @@ import TabItem from '@theme/TabItem';
This page only shows **some frequently used operations**.
- - For the latest and complete information about `Pulsar admin`, including commands, flags, descriptions, and more information, see [Pulsar admin doc](/tools/pulsar-admin/).
+ - For the latest and complete information about `Pulsar admin`, including commands, flags, descriptions, and more information, see [Pulsar admin doc](https://pulsar.apache.org/reference/#/@pulsar:version_origin@/pulsar-admin/).
Review Comment:
Good to know that. I can update them as long as the logic is stable:)
And do you know whether the built-in link checker can cover broken internal links like this?
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@pulsar.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [pulsar-site] tisonkun commented on a diff in pull request #459: [improve][doc] Improve the links to reference docs with versions and anchors
Posted by "tisonkun (via GitHub)" <gi...@apache.org>.
tisonkun commented on code in PR #459:
URL: https://github.com/apache/pulsar-site/pull/459#discussion_r1127688662
##########
docs/admin-api-brokers.md:
##########
@@ -14,7 +14,7 @@ import TabItem from '@theme/TabItem';
This page only shows **some frequently used operations**.
- - For the latest and complete information about `Pulsar admin`, including commands, flags, descriptions, and more information, see [Pulsar admin doc](/tools/pulsar-admin/).
+ - For the latest and complete information about `Pulsar admin`, including commands, flags, descriptions, and more information, see [Pulsar admin doc](https://pulsar.apache.org/reference/#/@pulsar:version_origin@/pulsar-admin/).
Review Comment:
Yes.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@pulsar.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [pulsar-site] momo-jun merged pull request #459: [improve][doc] Improve the links to reference docs with versions and anchors
Posted by "momo-jun (via GitHub)" <gi...@apache.org>.
momo-jun merged PR #459:
URL: https://github.com/apache/pulsar-site/pull/459
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@pulsar.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org