Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Doc] Add docs for multiple host in Go client #10037

Merged
merged 3 commits into from
Mar 25, 2021

Conversation

Anonymitaet
Copy link
Member

@Anonymitaet
Copy link
Member Author

@freeznet @jennifer88huang @Huanli-Meng could you please help review? Thanks

@@ -150,7 +150,6 @@
"Reference": [
"version-2.7.1-reference-terminology",
"version-2.7.1-reference-cli-tools",
"version-2.7.1-pulsar-admin",
Copy link
Member

Choose a reason for hiding this comment

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

This will remove the pulsar-admin cli page from the website, right? I think it would be really valuable to leave this page in place and to put a banner at the top to indicate the page is deprecated and that there is a new/updated pulsar admin cli website. As a user, I'd be surprised if this page would just suddenly disappear because I didn't know it was out of date or that there was a new/different place to look for the pulsar admin cli documentation.

Copy link
Member Author

Choose a reason for hiding this comment

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

We already have a "button" at the top navigation since the beginning. It is easy to find and use.
image

Copy link
Member

Choose a reason for hiding this comment

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

Thanks for pointing out that documentation. I agree that it will be easy for new users to find and use.

Although, users who were using the old pulsar admin client cli documentation might be confused when that portion of the website suddenly disappears. I would have been one of those users. I had been using that section of the documentation without realizing that the top level cli client documentation existed.

While I had seen the pulsar admin cli tool website, I didn't know that it was more up to date, so I had continued to use the older version. A banner or some type of redirection to the new website could help users make the transition to the right documentation. I think this is ultimately a great change, but I also want to ease transition for users that were used to the old documentation.

@Anonymitaet Anonymitaet added the doc Your PR contains doc changes, no matter whether the changes are in markdown or code files. label Mar 25, 2021
@Anonymitaet Anonymitaet merged commit 30f3dda into apache:master Mar 25, 2021
@Anonymitaet Anonymitaet deleted the 0325 branch March 25, 2021 23:23
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/cli doc Your PR contains doc changes, no matter whether the changes are in markdown or code files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants