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 2021/12/24 13:02:33 UTC

[GitHub] [pulsar] ericsyh opened a new pull request #13494: fix(docs): replace pulsarctl in offload docs

ericsyh opened a new pull request #13494:
URL: https://github.com/apache/pulsar/pull/13494


   Signed-off-by: Eric Shen <er...@outlook.com>
   
   <!--
   ### Contribution Checklist
     
     - Name the pull request in the form "[Issue XYZ][component] Title of the pull request", where *XYZ* should be replaced by the actual issue number.
       Skip *Issue XYZ* if there is no associated github issue for this pull request.
       Skip *component* if you are unsure about which is the best component. E.g. `[docs] Fix typo in produce method`.
   
     - Fill out the template below to describe the changes contributed by the pull request. That will give reviewers the context they need to do the review.
     
     - Each pull request should address only one issue, not mix up code from multiple issues.
     
     - Each commit in the pull request has a meaningful commit message
   
     - Once all items of the checklist are addressed, remove the above text and this checklist, leaving only the filled out template below.
   
   **(The sections below can be removed for hotfixes of typos)**
   -->
   
   ### Motivation
   
   In the [tiered-storage-filesystem](https://pulsar.apache.org/docs/en/2.8.1/tiered-storage-filesystem/) tutorial uses `pulsarctl`. But it is confusing for users that pulsar docs has no context about `pulsarctl`, so i think it will be better to use `pulsar-admin` to keep consistent. 
   
   ### Modifications
   
   Replace `pulsarctl` with `pulsar-admin` in [tiered-storage-filesystem](https://pulsar.apache.org/docs/en/2.8.1/tiered-storage-filesystem/) 
   
   ### Verifying this change
   
   - [x] Make sure that the change passes the CI checks.
   
   *(Please pick either of the following options)*
   
   This change is a trivial rework / code cleanup without any test coverage.
   
   *(or)*
   
   This change is already covered by existing tests, such as *(please describe tests)*.
   
   *(or)*
   
   This change added tests and can be verified as follows:
   
   *(example:)*
     - *Added integration tests for end-to-end deployment with large payloads (10MB)*
     - *Extended integration test for recovery after broker failure*
   
   ### Does this pull request potentially affect one of the following parts:
   
   *If `yes` was chosen, please highlight the changes*
   
     - Dependencies (does it add or upgrade a dependency): (no)
     - The public API: (no)
     - The schema: (no)
     - The default values of configurations: (no)
     - The wire protocol: (no)
     - The rest endpoints: (no)
     - The admin cli options: (no)
     - Anything that affects deployment: (no)
   
   ### Documentation
   
   Check the box below and label this PR (if you have committer privilege).
   
   Need to update docs? 
   
   - [ ] `doc-required` 
     
     (If you need help on updating docs, create a doc issue)
     
   - [ ] `no-need-doc` 
     
     (Please explain why)
     
   - [x] `doc` 
     
     (If this PR contains doc changes)
   
   
   


-- 
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 change in pull request #13494: fix(docs): replace pulsarctl in offload docs

Posted by GitBox <gi...@apache.org>.
Anonymitaet commented on a change in pull request #13494:
URL: https://github.com/apache/pulsar/pull/13494#discussion_r775314226



##########
File path: site2/docs/tiered-storage-filesystem.md
##########
@@ -392,13 +392,13 @@ Execute the following commands in the repository where you download Pulsar tarba
 1. Start Pulsar standalone.
 
     ```
-    ./bin/pulsar standalone -a 127.0.0.1
+    bin/pulsar standalone -a 127.0.0.1

Review comment:
       I think the original text is correct, why modify 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] ericsyh commented on a change in pull request #13494: fix(docs): replace pulsarctl in offload docs

Posted by GitBox <gi...@apache.org>.
ericsyh commented on a change in pull request #13494:
URL: https://github.com/apache/pulsar/pull/13494#discussion_r775316811



##########
File path: site2/docs/tiered-storage-filesystem.md
##########
@@ -392,13 +392,13 @@ Execute the following commands in the repository where you download Pulsar tarba
 1. Start Pulsar standalone.
 
     ```
-    ./bin/pulsar standalone -a 127.0.0.1
+    bin/pulsar standalone -a 127.0.0.1

Review comment:
       Yes, `.bin/pulsar` also works, i just want to keep consistent with other docs like [administration-geo](https://pulsar.apache.org/docs/en/administration-geo/) and [standalone consume-a-message)](https://pulsar.apache.org/docs/en/standalone/#consume-a-message). Most of Pulsar docs use `bin/pulsar`.




-- 
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 merged pull request #13494: fix(docs): replace pulsarctl in offload docs

Posted by GitBox <gi...@apache.org>.
Anonymitaet merged pull request #13494:
URL: https://github.com/apache/pulsar/pull/13494


   


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