You are viewing a plain text version of this content. The canonical link for it is here.
Posted to notifications@apisix.apache.org by GitBox <gi...@apache.org> on 2022/01/26 14:12:06 UTC

[GitHub] [apisix] hf400159 opened a new pull request #6213: docs:improve doc

hf400159 opened a new pull request #6213:
URL: https://github.com/apache/apisix/pull/6213


   ### What this PR does / why we need it:
   
   Add the cpanm installation command.
   Modified etcd startup command to add log output parameters.
   Remove the "$" sign before each command.
   
   * [ ] Did you explain what problem does this PR solve? Or what new features have been added?
   * [ ] Have you added corresponding test cases?
   * [ ] Have you modified the corresponding document?
   * [ ] Is this PR backward compatible? **If it is not backward compatible, please discuss on the [mailing list](https://github.com/apache/apisix/tree/master#community) first**
   


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: notifications-unsubscribe@apisix.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org



[GitHub] [apisix] zaunist commented on a change in pull request #6213: doc:improve docs

Posted by GitBox <gi...@apache.org>.
zaunist commented on a change in pull request #6213:
URL: https://github.com/apache/apisix/pull/6213#discussion_r792693055



##########
File path: docs/en/latest/how-to-build.md
##########
@@ -84,33 +84,33 @@ Please refer to: [Installing Apache APISIX with Helm Chart](https://github.com/a
 1. Create a directory named `apisix-2.12.0`.
 
   ```shell
-  $ APISIX_VERSION='2.12.0'
-  $ mkdir apisix-${APISIX_VERSION}
+  APISIX_VERSION='2.12.0'
+  mkdir apisix-${APISIX_VERSION}
   ```
 
 2. Download Apache APISIX Release source package.
 
   ```shell
-  $ wget https://downloads.apache.org/apisix/${APISIX_VERSION}/apache-apisix-${APISIX_VERSION}-src.tgz
+  wget https://downloads.apache.org/apisix/${APISIX_VERSION}/apache-apisix-${APISIX_VERSION}-src.tgz
   ```
 
   You can also download the Apache APISIX Release source package from the Apache APISIX website. The [Apache APISIX Official Website - Download Page](https://apisix.apache.org/downloads/) also provides source packages for Apache APISIX, APISIX Dashboard and APISIX Ingress Controller.
 
 3. Unzip the Apache APISIX Release source package.
 
   ```shell
-  $ tar zxvf apache-apisix-${APISIX_VERSION}-src.tgz -C apisix-${APISIX_VERSION}
+  tar zxvf apache-apisix-${APISIX_VERSION}-src.tgz -C apisix-${APISIX_VERSION}
   ```
 
 4. Install the runtime dependent Lua libraries.
 
   ```shell
-  # Switch to the apisix-${APISIX_VERSION} directory
-  $ cd apisix-${APISIX_VERSION}
+  Switch to the apisix-${APISIX_VERSION} directory

Review comment:
       ```suggestion
    # Switch to the apisix-${APISIX_VERSION} directory
   ```
   Should we need to keep the `#` ?




-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: notifications-unsubscribe@apisix.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org



[GitHub] [apisix] spacewander commented on a change in pull request #6213: docs: added cpanm installation commands and remove $ sign

Posted by GitBox <gi...@apache.org>.
spacewander commented on a change in pull request #6213:
URL: https://github.com/apache/apisix/pull/6213#discussion_r802598291



##########
File path: docs/en/latest/how-to-build.md
##########
@@ -185,23 +185,29 @@ Run the `apisix help` command to see the returned results and get commands and d
 
 ```shell
 # more actions find by `help`
-$ apisix help
+apisix help
 ```
 
 ## Step 4: Run Test Cases
 
 1. Install `cpanminus`, the package manager for `perl`.
 
+```shell
+cd /bin
+curl -L https://cpanmin.us/ -o cpanm

Review comment:
       Don't we need sudo to write a file under `/bin`?




-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: notifications-unsubscribe@apisix.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org



[GitHub] [apisix] hf400159 commented on pull request #6213: docs: added cpanm installation commands and remove $ sign

Posted by GitBox <gi...@apache.org>.
hf400159 commented on pull request #6213:
URL: https://github.com/apache/apisix/pull/6213#issuecomment-1032251348


   @bisakhmondal hi,can you review this pr? Is there anything wrong with it? thanks.


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: notifications-unsubscribe@apisix.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org



[GitHub] [apisix] hf400159 closed pull request #6213: docs: added cpanm installation commands and remove $ sign

Posted by GitBox <gi...@apache.org>.
hf400159 closed pull request #6213:
URL: https://github.com/apache/apisix/pull/6213


   


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: notifications-unsubscribe@apisix.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org



[GitHub] [apisix] juzhiyuan commented on a change in pull request #6213: docs: added cpanm installation commands and remove $ sign

Posted by GitBox <gi...@apache.org>.
juzhiyuan commented on a change in pull request #6213:
URL: https://github.com/apache/apisix/pull/6213#discussion_r793156752



##########
File path: docs/en/latest/how-to-build.md
##########
@@ -185,23 +185,29 @@ Run the `apisix help` command to see the returned results and get commands and d
 
 ```shell
 # more actions find by `help`
-$ apisix help
+apisix help
 ```
 
 ## Step 4: Run Test Cases
 
-1. Install `cpanminus`, the package manager for `perl`.
+1. Install `cpanminus`, the package manager for `perl`and dependencies.

Review comment:
       ```suggestion
   1. Install `cpanminus`, the package manager for `perl` and dependencies.
   ```




-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: notifications-unsubscribe@apisix.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org



[GitHub] [apisix] hf400159 commented on a change in pull request #6213: docs: added cpanm installation commands and remove $ sign

Posted by GitBox <gi...@apache.org>.
hf400159 commented on a change in pull request #6213:
URL: https://github.com/apache/apisix/pull/6213#discussion_r793162434



##########
File path: docs/en/latest/how-to-build.md
##########
@@ -185,23 +185,29 @@ Run the `apisix help` command to see the returned results and get commands and d
 
 ```shell
 # more actions find by `help`
-$ apisix help
+apisix help
 ```
 
 ## Step 4: Run Test Cases
 
-1. Install `cpanminus`, the package manager for `perl`.
+1. Install `cpanminus`, the package manager for `perl`and dependencies.

Review comment:
       Remove ‘and dependencies’, because there is no installation package for this step.




-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: notifications-unsubscribe@apisix.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org



[GitHub] [apisix] hf400159 commented on pull request #6213: docs: added cpanm installation commands and remove $ sign

Posted by GitBox <gi...@apache.org>.
hf400159 commented on pull request #6213:
URL: https://github.com/apache/apisix/pull/6213#issuecomment-1032269266


   @bzp2010  hi,can you review this pr ? thanks


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: notifications-unsubscribe@apisix.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org



[GitHub] [apisix] bisakhmondal commented on a change in pull request #6213: docs: added cpanm installation commands and remove $ sign

Posted by GitBox <gi...@apache.org>.
bisakhmondal commented on a change in pull request #6213:
URL: https://github.com/apache/apisix/pull/6213#discussion_r801302373



##########
File path: docs/en/latest/how-to-build.md
##########
@@ -120,12 +120,12 @@ This step is required if you have installed only Apache APISIX via RPM, Docker o
 You can install ETCD via Docker or binary etc. The following command installs ETCD via binary.
 
 ```shell
-$ ETCD_VERSION='3.4.13'
-$ wget https://github.com/etcd-io/etcd/releases/download/v${ETCD_VERSION}/etcd-v${ETCD_VERSION}-linux-amd64.tar.gz
-$ tar -xvf etcd-v${ETCD_VERSION}-linux-amd64.tar.gz && \
-    cd etcd-v${ETCD_VERSION}-linux-amd64 && \
-    sudo cp -a etcd etcdctl /usr/bin/
-$ nohup etcd &
+ETCD_VERSION='3.4.13'
+wget https://github.com/etcd-io/etcd/releases/download/v${ETCD_VERSION}/etcd-v${ETCD_VERSION}-linux-amd64.tar.gz
+tar -xvf etcd-v${ETCD_VERSION}-linux-amd64.tar.gz && \
+  cd etcd-v${ETCD_VERSION}-linux-amd64 && \
+  sudo cp -a etcd etcdctl /usr/bin/
+nohup etcd >/tmp/etcd.log 2>&1 &

Review comment:
       nice

##########
File path: docs/en/latest/how-to-build.md
##########
@@ -185,23 +185,29 @@ Run the `apisix help` command to see the returned results and get commands and d
 
 ```shell
 # more actions find by `help`
-$ apisix help
+apisix help
 ```
 
 ## Step 4: Run Test Cases
 
 1. Install `cpanminus`, the package manager for `perl`.
 
+```shell
+cd /bin
+curl -L https://cpanmin.us/ -o cpanm
+chmod +x cpanm

Review comment:
       ```suggestion
   curl -L https://cpanmin.us/ -o cpanm
   chmod +x cpanm
   # optional
   mv cpanm /bin
   ```
   This should be a suggestion, not a strict requirement?




-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: notifications-unsubscribe@apisix.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org