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/09/12 04:42:47 UTC

[GitHub] [pulsar] SignorMercurio opened a new pull request, #17585: [fix][doc] Remove redundant steps in doc generation

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

   ### Motivation
   
   Docs for Pulsar CLI tools such as `pulsar-admin`, `pulsar-client`, `pulsar` and `pulsar-perf` are auto-generated but contains redundant steps that will produce complex but not useful TOCs(table of content). This PR aims to remove these steps.
   
   ### Modifications
   
   Remove all `---`, `Usage` and `bdocs-tab:example_shell` parts since they are no longer useful.
   
   ### Verifying this change
   
   - [x] Make sure that the change passes the CI checks.
   
   This change is a trivial rework / code cleanup without any test coverage.
   
   ### Does this pull request potentially affect one of the following parts:
   
   *If the box was checked, please highlight the changes*
   
   - [ ] Dependencies (add or upgrade a dependency)
   - [ ] The public API
   - [ ] The schema
   - [ ] The default values of configurations
   - [ ] The binary protocol
   - [ ] The REST endpoints
   - [ ] The admin CLI options
   - [ ] Anything that affects deployment
   
   ### Documentation
   
   <!-- DO NOT REMOVE THIS SECTION. CHECK THE PROPER BOX ONLY. -->
   
   - [ ] `doc-required` 
   (Your PR needs to update docs and you will update later)
   
   - [ ] `doc-not-needed` 
   (Please explain why)
   
   - [x] `doc` 
   (Your PR contains doc changes)
   
   - [ ] `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] SignorMercurio commented on pull request #17585: [fix][doc] Remove redundant steps in doc generation

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

   /pulsarbot run-failure-checks


-- 
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 #17585: [fix][doc] Remove redundant steps in doc generation

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


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