Skip to content

cleanup cli docs generation: BUILD_ALL_VERSION=1 - #273

Merged
Anonymitaet merged 1 commit into
apache:mainfrom
tisonkun:cleanup-cli-docs
Nov 1, 2022
Merged

cleanup cli docs generation: BUILD_ALL_VERSION=1#273
Anonymitaet merged 1 commit into
apache:mainfrom
tisonkun:cleanup-cli-docs

Conversation

@tisonkun

Copy link
Copy Markdown
Member

Signed-off-by: tison wander4096@gmail.com

Signed-off-by: tison <wander4096@gmail.com>
@tisonkun

Copy link
Copy Markdown
Member Author

Usage

```bash
broker-tool command

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It seems that we remove this utility for a long time.

cc @merlimat @codelipenghui @nicoloboschi do you have ideas of the specific commit we remove this tool? I'm thinking of which versions of docs we should do the corresponding changes.

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Comment on lines -55 to -61

# copy CLI tools docs
tools="bookkeeper pulsar-daemon pulsar-shell"
for tool in $tools
do
cp "$WEBSITE/docs/reference-cli-$tool.md" "$VERSIONED_DIR/$tool/$tool.md"
done

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This code snippet along with the existence of the reference-cli-* files causes the current https://pulsar.apache.org/reference/#/next/bookkeeper/bookkeeper page still have a wrongly parsed yaml header.

We need to remove all this stuff to finish what @Anonymitaet proposed at apache/pulsar#18101

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@SignorMercurio would you pls help to double-check it? thanks.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes, this code snippet is no longer needed and should be removed. So does reference-cli-*.md. Thanks @tisonkun!

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

OK, thank you all!

@tisonkun

tisonkun commented Nov 1, 2022

Copy link
Copy Markdown
Member Author

ping @Anonymitaet @urfreespace as a reminder. I think this patch is ready to merge.

@Anonymitaet
Anonymitaet merged commit 704ccf5 into apache:main Nov 1, 2022
@tisonkun
tisonkun deleted the cleanup-cli-docs branch December 29, 2022 01:06
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants