[fix][doc] Remove redundant steps in doc generation #17585
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Signed-off-by: Mercurio <[email protected]>
github-actions
bot
added
the
doc
Signed-off-by: Mercurio <[email protected]>
Signed-off-by: Mercurio <[email protected]>
Anonymitaet
approved these changes
Sep 19, 2022
Signed-off-by: Mercurio <[email protected]>
urfreespace
approved these changes
Sep 23, 2022
|
/pulsarbot run-failure-checks |
Signed-off-by: Mercurio <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Matching PR in forked repository
SignorMercurio#3
Motivation
Docs for Pulsar CLI tools such as
pulsar-admin,pulsar-client,pulsarandpulsar-perfare 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
---,Usageandbdocs-tab:example_shellparts since they are no longer useful.Verifying this change
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
Documentation
doc-required(Your PR needs to update docs and you will update later)
doc-not-needed(Please explain why)
doc(Your PR contains doc changes)
doc-complete(Docs have been already added)