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

[improve][docs] Get started locally #17475

Merged
merged 16 commits into from
Sep 7, 2022

Conversation

tisonkun
Copy link
Member

@tisonkun tisonkun commented Sep 5, 2022

Fixes #17409.

For description, read the issue description and these two comments: #17409 (comment) + #17409 (comment).

  • doc

cc @Anonymitaet @momo-jun @DaveDuggins @labuladong @merlimat @TheYonk

@github-actions github-actions bot added the doc Your PR contains doc changes, no matter whether the changes are in markdown or code files. label Sep 5, 2022
@tisonkun tisonkun changed the title Improve get started locally [improve][docs] Get started locally Sep 5, 2022
@tisonkun
Copy link
Member Author

tisonkun commented Sep 5, 2022

There are some back links to install connectors and offloaders. I'll resolve them separately in another PR.

Signed-off-by: tison <[email protected]>
site2/docs/getting-started-home.md Show resolved Hide resolved
site2/docs/getting-started-standalone.md Show resolved Hide resolved
Copy link
Member

@Anonymitaet Anonymitaet left a comment

Choose a reason for hiding this comment

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

Why remove bin/pulsar-daemon start standalone part? Is it a rare use case?

site2/docs/getting-started-standalone.md Outdated Show resolved Hide resolved
site2/docs/getting-started-standalone.md Outdated Show resolved Hide resolved
site2/docs/getting-started-standalone.md Outdated Show resolved Hide resolved
site2/docs/getting-started-standalone.md Outdated Show resolved Hide resolved
site2/docs/getting-started-standalone.md Outdated Show resolved Hide resolved
site2/docs/getting-started-standalone.md Outdated Show resolved Hide resolved
site2/docs/getting-started-standalone.md Outdated Show resolved Hide resolved
site2/docs/getting-started-standalone.md Outdated Show resolved Hide resolved
site2/docs/getting-started-standalone.md Show resolved Hide resolved
site2/docs/getting-started-standalone.md Show resolved Hide resolved
@Anonymitaet
Copy link
Member

Thanks for your contribution! Feel free to correct me if my understanding is inaccurate.

@Anonymitaet Anonymitaet added this to the 2.12.0 milestone Sep 6, 2022
@Anonymitaet
Copy link
Member

@D-2-Ed any thoughts on this? Thank you!

@tisonkun
Copy link
Member Author

tisonkun commented Sep 6, 2022

@Anonymitaet thanks for your reviews! Comments addressed.

@tisonkun
Copy link
Member Author

tisonkun commented Sep 6, 2022

Why remove bin/pulsar-daemon start standalone part

You're right that we can add back the tip. Updated.

Copy link
Member

@Anonymitaet Anonymitaet left a comment

Choose a reason for hiding this comment

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

Thanks for your contribution! Have you previewed your changes to ensure everything goes as expected?

If not yet, please preview your changes locally and attach the screenshots in the PR description to let others know. In this way, you can get your PR merged more quickly. Thanks!

site2/docs/getting-started-standalone.md Outdated Show resolved Hide resolved
site2/docs/getting-started-standalone.md Outdated Show resolved Hide resolved
@tisonkun
Copy link
Member Author

tisonkun commented Sep 6, 2022

@Anonymitaet Have you previewed your changes to ensure everything goes as expected?

Aha, I preview each change in batch. It's OK that I attach some screenshots. I didn't do it in the first place because it's almost a new page longer than one screen and I'd prefer the reviewers can preview themselves. Also, it's easily outdated as the review is in progress.

Signed-off-by: tison <[email protected]>
@tisonkun
Copy link
Member Author

tisonkun commented Sep 6, 2022

@Anonymitaet Uploaded previews here:

image

image

image

image

@Anonymitaet
Copy link
Member

@tisonkun thanks! Feel free to ping me to merge this PR after all tests pass.

@tisonkun
Copy link
Member Author

tisonkun commented Sep 7, 2022

This patch should be ready to merge. cc @Anonymitaet @momo-jun @RobertIndie

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
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.

[Doc] Simplify the get started page for local cluster
5 participants