You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@pulsar.apache.org by GitBox <gi...@apache.org> on 2022/10/19 04:59:26 UTC

[GitHub] [pulsar] Anonymitaet opened a new pull request, #18101: [fix][doc] Optimize URLs for CLI tools page

Anonymitaet opened a new pull request, #18101:
URL: https://github.com/apache/pulsar/pull/18101

   This PR:
   
   1. Removes metadata since it should not be shown on the Reference site
   
   <img width="1855" alt="image" src="https://user-images.githubusercontent.com/50226895/196601135-e651fde0-24a8-4c53-a621-d09ea9e1ee3d.png">
   
   2. Removes `broker-tool` because https://github.com/apache/pulsar/pull/18051#issuecomment-1280297019
   
   3. Update URLs to https://pulsar.apache.org/reference to make it's more generic and easier to maintain 
   
   - [x] `doc` <!-- Your PR contains doc changes. Please attach the local preview screenshots (run `sh start.sh` at `pulsar/site2/website`) to your PR description, or else your PR might not get merged. -->
   
   
   


-- 
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] Anonymitaet commented on pull request #18101: [fix][doc] Optimize URLs for CLI tools page

Posted by GitBox <gi...@apache.org>.
Anonymitaet commented on PR #18101:
URL: https://github.com/apache/pulsar/pull/18101#issuecomment-1291377737

   ping @momo-jun 


-- 
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] Anonymitaet commented on a diff in pull request #18101: [fix][doc] Optimize URLs for CLI tools page

Posted by GitBox <gi...@apache.org>.
Anonymitaet commented on code in PR #18101:
URL: https://github.com/apache/pulsar/pull/18101#discussion_r999088537


##########
site2/docs/reference-cli-bookkeeper.md:
##########
@@ -1,10 +1,5 @@
----
-id: reference-cli-bookkeeper
-title: Pulsar CLI tools - bookkeeper
-sidebar_label: "cli-bookkeeper"
----

Review Comment:
   @SignorMercurio can I use this? Does it work?



-- 
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] Anonymitaet commented on pull request #18101: [fix][doc] Optimize URLs for CLI tools page

Posted by GitBox <gi...@apache.org>.
Anonymitaet commented on PR #18101:
URL: https://github.com/apache/pulsar/pull/18101#issuecomment-1289899596

   Ping @momo-jun to review


-- 
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] SignorMercurio commented on a diff in pull request #18101: [fix][doc] Optimize URLs for CLI tools page

Posted by GitBox <gi...@apache.org>.
SignorMercurio commented on code in PR #18101:
URL: https://github.com/apache/pulsar/pull/18101#discussion_r999141777


##########
site2/docs/reference-cli-bookkeeper.md:
##########
@@ -1,10 +1,5 @@
----
-id: reference-cli-bookkeeper
-title: Pulsar CLI tools - bookkeeper
-sidebar_label: "cli-bookkeeper"
----

Review Comment:
   No, the aim is not redirecting. Actually, `reference-cli-bookkeeper.md` (and the below) will not be shown on `pulsar.apache.org`. Rather, it'll be shown only in `pulsar.apache.org/reference`. Therefore, the frontmatter is no longer useful as it only works for Docusaurus.



-- 
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] Anonymitaet commented on a diff in pull request #18101: [fix][doc] Optimize URLs for CLI tools page

Posted by GitBox <gi...@apache.org>.
Anonymitaet commented on code in PR #18101:
URL: https://github.com/apache/pulsar/pull/18101#discussion_r999087575


##########
site2/docs/about.md:
##########
@@ -55,7 +55,7 @@ You’ll notice an Edit button at the bottom and top of each page. Click it to o
 
 :::tip
 
-For how to make contributions to documentation, see [Pulsar Documentation Contribution Guide](https://docs.google.com/document/d/11DTnNPpvcPrebLkMAFcDEIFlD8ARD-k6F-LXoIwdD9Y/edit#).
+For how to make contributions to documentation, see [Pulsar Documentation Contribution Guide](../README.md).

Review Comment:
   Sorry I don't fully understand this comment
   
   Now the `doc contribution guide overview` is in `site2/README.md`, and `[Pulsar Documentation Contribution Guide](../README.md)` redirects users to the correct place.
   
   <img width="830" alt="image" src="https://user-images.githubusercontent.com/50226895/196633278-31d618e0-2857-40fa-a764-469613f37c17.png">
   



-- 
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] Anonymitaet commented on pull request #18101: [fix][doc] Optimize URLs for CLI tools page

Posted by GitBox <gi...@apache.org>.
Anonymitaet commented on PR #18101:
URL: https://github.com/apache/pulsar/pull/18101#issuecomment-1283537738

   @SignorMercurio updated as you suggested, PTAL


-- 
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] tisonkun commented on a diff in pull request #18101: [fix][doc] Optimize URLs for CLI tools page

Posted by GitBox <gi...@apache.org>.
tisonkun commented on code in PR #18101:
URL: https://github.com/apache/pulsar/pull/18101#discussion_r999036594


##########
site2/docs/reference-cli-pulsar-daemon.md:
##########
@@ -1,9 +1,3 @@
----
-id: reference-cli-pulsar-daemon
-title: Pulsar CLI tools - pulsar-daemon
-sidebar_label: "cli-pulsar-daemon"
----
-

Review Comment:
   ditto



##########
site2/docs/about.md:
##########
@@ -55,7 +55,7 @@ You’ll notice an Edit button at the bottom and top of each page. Click it to o
 
 :::tip
 
-For how to make contributions to documentation, see [Pulsar Documentation Contribution Guide](https://docs.google.com/document/d/11DTnNPpvcPrebLkMAFcDEIFlD8ARD-k6F-LXoIwdD9Y/edit#).
+For how to make contributions to documentation, see [Pulsar Documentation Contribution Guide](../README.md).

Review Comment:
   We don't move this `README.md` file to the site repo.
   
   You can use https://github.com/apache/pulsar/blob/master/site2/README.md as a workaround, which I hope we can move into another doc page and update these links to the new page.



##########
site2/docs/reference-cli-bookkeeper.md:
##########
@@ -1,10 +1,5 @@
----
-id: reference-cli-bookkeeper
-title: Pulsar CLI tools - bookkeeper
-sidebar_label: "cli-bookkeeper"
----

Review Comment:
   Why do you make these chanes? If you'd like to set up redirections, I suggest:
   
   ```
   ````mdx-code-block
   import {Redirect} from '@docusaurus/router';
   <Redirect to="/reference" />
   ````
   ```



##########
site2/docs/reference-cli-broker-tool.md:
##########
@@ -1,36 +0,0 @@
----
-id: reference-cli-broker-tool
-title: Pulsar CLI tools - broker-tool
-sidebar_label: "cli-broker-tool"
----

Review Comment:
   ditto



-- 
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] codelipenghui merged pull request #18101: [fix][doc] Optimize URLs for CLI tools page

Posted by GitBox <gi...@apache.org>.
codelipenghui merged PR #18101:
URL: https://github.com/apache/pulsar/pull/18101


-- 
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] Anonymitaet commented on pull request #18101: [fix][doc] Optimize URLs for CLI tools page

Posted by GitBox <gi...@apache.org>.
Anonymitaet commented on PR #18101:
URL: https://github.com/apache/pulsar/pull/18101#issuecomment-1283542571

   @tisonkun 
   > Update URLs to https://pulsar.apache.org/reference to make it more generic and easier to maintain
   
   All commands in the green box are on the same page, so I set them all to https://pulsar.apache.org/reference (users can choose versions then) instead of individual links for lower maintenance costs and a temporary workaround for https://github.com/apache/pulsar/pull/18051#discussion_r998840842
   <img width="325" alt="image" src="https://user-images.githubusercontent.com/50226895/196622066-6b84a592-f01e-4670-a698-b2ec1990002d.png">
   
   


-- 
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] tisonkun commented on a diff in pull request #18101: [fix][doc] Optimize URLs for CLI tools page

Posted by GitBox <gi...@apache.org>.
tisonkun commented on code in PR #18101:
URL: https://github.com/apache/pulsar/pull/18101#discussion_r999036457


##########
site2/docs/reference-cli-bookkeeper.md:
##########
@@ -1,10 +1,5 @@
----
-id: reference-cli-bookkeeper
-title: Pulsar CLI tools - bookkeeper
-sidebar_label: "cli-bookkeeper"
----

Review Comment:
   Why do you make these chanes? If you'd like to set up redirections, I suggest:
   
   <pre>
   ````mdx-code-block
   import {Redirect} from '@docusaurus/router';
   
   &lt;Redirect to="/reference" /&gt;
   ````
   </pre>



-- 
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] Anonymitaet commented on pull request #18101: [fix][doc] Optimize URLs for CLI tools page

Posted by GitBox <gi...@apache.org>.
Anonymitaet commented on PR #18101:
URL: https://github.com/apache/pulsar/pull/18101#issuecomment-1284853451

   Hi @tisonkun @SignorMercurio I‘ve updated based on your comments:
   - Remove reference-cli-bookkeeper.md and reference-cli-pulsar-daemon.md
   - Update URL 
   
   PTAL and feel free to approve, thanks.


-- 
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] Anonymitaet commented on pull request #18101: [fix][doc] Optimize URLs for CLI tools page

Posted by GitBox <gi...@apache.org>.
Anonymitaet commented on PR #18101:
URL: https://github.com/apache/pulsar/pull/18101#issuecomment-1289893380

   > Generally looks good. I suggest you leave the removing and moving reference cli docs task to @SignorMercurio so that he can simultaneously handle the process.
   > 
   > Otherwise, site build can fail and it takes more effort to recover these files and copy to the pulsar-site repo.
   > 
   > That is, do not remove:
   > 
   > * reference-cli-bookkeeper.md
   > * reference-cli-broker-tool.md
   > * reference-cli-pulsar-daemon.md
   > 
   > in this pull request. I think @SignorMercurio will handle it later.
   
   @tisonkun OK, I've updated this PR based on your comments, PTAL


-- 
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] Anonymitaet commented on pull request #18101: [fix][doc] Optimize URLs for CLI tools page

Posted by GitBox <gi...@apache.org>.
Anonymitaet commented on PR #18101:
URL: https://github.com/apache/pulsar/pull/18101#issuecomment-1283431621

   @SignorMercurio 
   could you please review this PR from a technical perspective? Thank you!
   
   cc @tisonkun @momo-jun @DaveDuggins @D-2-Ed


-- 
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] tisonkun commented on a diff in pull request #18101: [fix][doc] Optimize URLs for CLI tools page

Posted by GitBox <gi...@apache.org>.
tisonkun commented on code in PR #18101:
URL: https://github.com/apache/pulsar/pull/18101#discussion_r999089135


##########
site2/docs/about.md:
##########
@@ -55,7 +55,7 @@ You’ll notice an Edit button at the bottom and top of each page. Click it to o
 
 :::tip
 
-For how to make contributions to documentation, see [Pulsar Documentation Contribution Guide](https://docs.google.com/document/d/11DTnNPpvcPrebLkMAFcDEIFlD8ARD-k6F-LXoIwdD9Y/edit#).
+For how to make contributions to documentation, see [Pulsar Documentation Contribution Guide](../README.md).

Review Comment:
   It works on the GitHub repository but not for the Pulsar website. You can try to preview it and verify if you can jump to the `README.md` file.



-- 
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