[doc] Improve Pulsar deployment AWS #5093
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
|
@Anonymitaet please review~ thank you^^ |
Anonymitaet
requested changes
Sep 2, 2019
site2/docs/deploy-aws.md
Outdated
| @@ -30,9 +30,9 @@ You can install Ansible on Linux or macOS using pip. | |||
| $ pip install ansible | |||
| ``` | |||
|
|
|||
| You can install Terraform using the instructions [here](https://www.terraform.io/intro/getting-started/install.html). | |||
| You can install Terraform following the instructions from [here](https://www.terraform.io/intro/getting-started/install.html). | |||
There was a problem hiding this comment.
Original is correct, why modify this sentence？
site2/docs/deploy-aws.md
Outdated
| @@ -41,11 +41,11 @@ $ cd pulsar/deployment/terraform-ansible/aws | |||
|
|
|||
| ## SSH setup | |||
|
|
|||
| > If you already have an SSH key and would like to use it, you skip generating the SSH keys and update `private_key_file` setting | |||
| > If you already have an SSH key and want to use it, you can skip the generating the SSH keys step and update `private_key_file` setting | |||
There was a problem hiding this comment.
Suggested change
| > If you already have an SSH key and want to use it, you can skip the generating the SSH keys step and update `private_key_file` setting | |
| > If you already have an SSH key and want to use it, you can skip the step of generating an SSH key and update `private_key_file` setting. |
site2/docs/deploy-aws.md
Outdated
| > For example, if you already had a private SSH key in `~/.ssh/pulsar_aws` and a public key in `~/.ssh/pulsar_aws.pub`, | ||
| > you can do followings: | ||
| > For example, if you already have a private SSH key in `~/.ssh/pulsar_aws` and a public key in `~/.ssh/pulsar_aws.pub`, | ||
| > you can do the following: |
There was a problem hiding this comment.
Suggested change
| > you can do the following: | |
| > follow the steps below. |
site2/docs/deploy-aws.md
Outdated
|
|
||
| For a quick demonstration of accessing the cluster, we can use the Python client for Pulsar and the Python shell. First, install the Pulsar Python module using pip: | ||
|
|
||
| ```bash | ||
| $ pip install pulsar-client | ||
| ``` | ||
|
|
||
| Now, open up the Python shell using the `python` command: | ||
| Now, open up the Python shell entering the `python` command: |
Anonymitaet
approved these changes
Sep 3, 2019
sijie
approved these changes
Sep 4, 2019
sijie
added
doc
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.
Motivation
Improve the language and the overall descriptive style of the Pulsar Deployment document (deploy-aws section): http://pulsar.apache.org/docs/en/next/deploy-aws/
Modifications
Adjust the tone, personal pronouns, voice also some typo errors of some sentences in the document.