fix(docs): incorrect command name and description for autorecovery #12989
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: Eric Shen <ericshenyuhao@outlook.com>
github-actions
bot
added
the
doc
Signed-off-by: Eric Shen <ericshenyuhao@outlook.com>
|
@Anonymitaet PTAL |
Anonymitaet
reviewed
Dec 2, 2021
Anonymitaet
reviewed
Dec 2, 2021
site2/docs/reference-cli-tools.md
Outdated
| ``` | ||
|
|
||
| Options | ||
|
|
||
| |Flag|Description|Default| | ||
| |---|---|---| | ||
| |`-c`, `--conf`|Configuration for the auto-recovery daemon|| | ||
| |`-c`, `--conf`|Configuration for the autorecovery|| |
There was a problem hiding this comment.
auto-recovery (or auto recovery) is a correct word in the description, why modify that?
There was a problem hiding this comment.
I agree, we should keep the auto-recovery term.
There was a problem hiding this comment.
OK, I updated in 94ebed6
Signed-off-by: Eric Shen <ericshenyuhao@outlook.com>
Anonymitaet
reviewed
Dec 3, 2021
site2/docs/reference-cli-tools.md
Outdated
| |-readOnly|Force start a read-only bookie server|false| | ||
| |-withAutoRecovery|Start auto-recovery service bookie server|false| | ||
| |-withAutoRecovery|Start autorecovery service bookie server|false| |
There was a problem hiding this comment.
Do you miss this one? (and many other places)
There was a problem hiding this comment.
Ok i will take a full check on it.
Signed-off-by: Eric Shen <ericshenyuhao@outlook.com>
Signed-off-by: Eric Shen <ericshenyuhao@outlook.com>
Anonymitaet
approved these changes
Dec 6, 2021
|
/pulsarbot run-failure-checks |
fxbing
pushed a commit
to fxbing/pulsar
that referenced
this pull request
Dec 19, 2021
…pache#12989) * fix(docs): incorrect command name and description for autorecovery Signed-off-by: Eric Shen <ericshenyuhao@outlook.com> * update description Signed-off-by: Eric Shen <ericshenyuhao@outlook.com> * rollback to auto-recovery term Signed-off-by: Eric Shen <ericshenyuhao@outlook.com> * fix missing Signed-off-by: Eric Shen <ericshenyuhao@outlook.com> * fix missing Signed-off-by: Eric Shen <ericshenyuhao@outlook.com>
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.
Signed-off-by: Eric Shen ericshenyuhao@outlook.com
Motivation
The command name and description of
bin/bookkeeper autorecoveryare not correct on docs now:bin/bookkeeper autorecoveryrather thanbin/bookkeeper auto-recoverybin/bookkeeper autorecoverywon't start autorecovery in daemon, PTAL the fix PR fix(cli): incorrect description for autodiscovery bookkeeper#2910. The daemon command is not supported onbin/pulsar-daemon, so i submitted a PR for it: feat(cli): support autorecovery service in pulsar cli #12985Modifications
bin/bookkeeper auto-recoverytobin/bookkeeper autorecoveryon related docs.Verifying this change
(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:)
Does this pull request potentially affect one of the following parts:
If
yeswas chosen, please highlight the changesDocumentation
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)
doc(If this PR contains doc changes)