SkyeYoung commented on a change in pull request #1001: URL: https://github.com/apache/apisix-website/pull/1001#discussion_r840991557
########## File path: README.md ########## @@ -7,14 +6,75 @@ The website of [Apache APISIX®](https://apisix.apache.org/), a cloud-native mic If you want to write a blog or fix some blog-related issues, please read [Apache APISIX Blog Contributing Guide](http://apisix.apache.org/docs/general/blog) first. Then create a pull request. -## Usage +--- + +# Contribution +Refer these basic steps to contribute. +## Contents +- [Environment-SetUp](#clone) +- [Start server](#build) +- [Run](#run) +- [Reference](#reference) + +## Clone +To run & test the project locally on your machine , you need to clone it locally. +you can do it by :- Review comment: `:-` What's this? 😶🌫️ ########## File path: README.md ########## @@ -7,14 +6,75 @@ The website of [Apache APISIX®](https://apisix.apache.org/), a cloud-native mic If you want to write a blog or fix some blog-related issues, please read [Apache APISIX Blog Contributing Guide](http://apisix.apache.org/docs/general/blog) first. Then create a pull request. -## Usage +--- + +# Contribution +Refer these basic steps to contribute. +## Contents Review comment: GitHub has TOC now, we can remove this part.  ########## File path: README.md ########## @@ -7,14 +6,75 @@ The website of [Apache APISIX®](https://apisix.apache.org/), a cloud-native mic If you want to write a blog or fix some blog-related issues, please read [Apache APISIX Blog Contributing Guide](http://apisix.apache.org/docs/general/blog) first. Then create a pull request. -## Usage +--- + +# Contribution +Refer these basic steps to contribute. +## Contents +- [Environment-SetUp](#clone) +- [Start server](#build) +- [Run](#run) +- [Reference](#reference) + +## Clone +To run & test the project locally on your machine , you need to clone it locally. +you can do it by :- ```sh +$ git clone https://github.com/apache/apisix-website.git $ cd website Review comment: Default folder name should be `apisix-website`. ```suggestion $ cd apisix-website ``` ########## File path: README.md ########## @@ -7,14 +6,75 @@ The website of [Apache APISIX®](https://apisix.apache.org/), a cloud-native mic If you want to write a blog or fix some blog-related issues, please read [Apache APISIX Blog Contributing Guide](http://apisix.apache.org/docs/general/blog) first. Then create a pull request. -## Usage +--- + +# Contribution +Refer these basic steps to contribute. +## Contents +- [Environment-SetUp](#clone) +- [Start server](#build) +- [Run](#run) +- [Reference](#reference) + +## Clone +To run & test the project locally on your machine , you need to clone it locally. +you can do it by :- ```sh +$ git clone https://github.com/apache/apisix-website.git $ cd website +``` +## Build +```sh +$ yarn build +``` +will build the existing project on your local machine. -$ yarn +**Note:-** Review comment: ```suggestion **Note:** ``` Here too. ########## File path: README.md ########## @@ -7,14 +6,75 @@ The website of [Apache APISIX®](https://apisix.apache.org/), a cloud-native mic If you want to write a blog or fix some blog-related issues, please read [Apache APISIX Blog Contributing Guide](http://apisix.apache.org/docs/general/blog) first. Then create a pull request. -## Usage +--- + +# Contribution +Refer these basic steps to contribute. +## Contents +- [Environment-SetUp](#clone) +- [Start server](#build) +- [Run](#run) +- [Reference](#reference) + +## Clone +To run & test the project locally on your machine , you need to clone it locally. Review comment: My fault. I haven't found time to add MarkDown Lint. ```suggestion To run & test the project locally on your machine, you need to clone it locally. ``` ########## File path: README.md ########## @@ -7,14 +6,75 @@ The website of [Apache APISIX®](https://apisix.apache.org/), a cloud-native mic If you want to write a blog or fix some blog-related issues, please read [Apache APISIX Blog Contributing Guide](http://apisix.apache.org/docs/general/blog) first. Then create a pull request. -## Usage +--- + +# Contribution +Refer these basic steps to contribute. +## Contents +- [Environment-SetUp](#clone) +- [Start server](#build) +- [Run](#run) +- [Reference](#reference) + +## Clone +To run & test the project locally on your machine , you need to clone it locally. +you can do it by :- ```sh +$ git clone https://github.com/apache/apisix-website.git $ cd website +``` +## Build +```sh +$ yarn build +``` +will build the existing project on your local machine. -$ yarn +**Note:-** +- Before using yarn build , make sure you are inside the main project folder. +if your current location on terminal is not inside the project folder then run, +```sh +$ cd website +``` +then build script. + +## Run +Now the main fun begins!! we will be using docusaurus for running and delployng our website on local server. Review comment: It may be necessary to modify the expression, the emotional statement is too much. ########## File path: README.md ########## @@ -7,14 +6,75 @@ The website of [Apache APISIX®](https://apisix.apache.org/), a cloud-native mic If you want to write a blog or fix some blog-related issues, please read [Apache APISIX Blog Contributing Guide](http://apisix.apache.org/docs/general/blog) first. Then create a pull request. -## Usage +--- + +# Contribution +Refer these basic steps to contribute. +## Contents +- [Environment-SetUp](#clone) +- [Start server](#build) +- [Run](#run) +- [Reference](#reference) + +## Clone +To run & test the project locally on your machine , you need to clone it locally. +you can do it by :- ```sh +$ git clone https://github.com/apache/apisix-website.git $ cd website +``` +## Build +```sh +$ yarn build +``` +will build the existing project on your local machine. -$ yarn +**Note:-** +- Before using yarn build , make sure you are inside the main project folder. +if your current location on terminal is not inside the project folder then run, +```sh +$ cd website +``` +then build script. + +## Run +Now the main fun begins!! we will be using docusaurus for running and delployng our website on local server. + +One can run , +```sh $ yarn start ``` +to start server or + +- To start the server on a specified port say ```3000``` try , +```sh + +$ docusaurus start --port Review comment: We cannot use this... We don't have a global installation. ########## File path: README.md ########## @@ -7,14 +6,75 @@ The website of [Apache APISIX®](https://apisix.apache.org/), a cloud-native mic If you want to write a blog or fix some blog-related issues, please read [Apache APISIX Blog Contributing Guide](http://apisix.apache.org/docs/general/blog) first. Then create a pull request. -## Usage +--- + +# Contribution +Refer these basic steps to contribute. +## Contents +- [Environment-SetUp](#clone) +- [Start server](#build) +- [Run](#run) +- [Reference](#reference) + +## Clone +To run & test the project locally on your machine , you need to clone it locally. +you can do it by :- ```sh +$ git clone https://github.com/apache/apisix-website.git $ cd website +``` +## Build +```sh +$ yarn build +``` +will build the existing project on your local machine. -$ yarn +**Note:-** +- Before using yarn build , make sure you are inside the main project folder. +if your current location on terminal is not inside the project folder then run, +```sh +$ cd website +``` +then build script. + +## Run +Now the main fun begins!! we will be using docusaurus for running and delployng our website on local server. + +One can run , +```sh $ yarn start ``` +to start server or + +- To start the server on a specified port say ```3000``` try , +```sh + +$ docusaurus start --port +``` +this will start the server on the default port ```3000``` Review comment: ```suggestion This will start the server on the default port `3000` ``` ########## File path: README.md ########## @@ -7,14 +6,75 @@ The website of [Apache APISIX®](https://apisix.apache.org/), a cloud-native mic If you want to write a blog or fix some blog-related issues, please read [Apache APISIX Blog Contributing Guide](http://apisix.apache.org/docs/general/blog) first. Then create a pull request. -## Usage +--- + +# Contribution +Refer these basic steps to contribute. +## Contents +- [Environment-SetUp](#clone) +- [Start server](#build) +- [Run](#run) +- [Reference](#reference) + +## Clone +To run & test the project locally on your machine , you need to clone it locally. +you can do it by :- ```sh +$ git clone https://github.com/apache/apisix-website.git $ cd website +``` +## Build +```sh +$ yarn build +``` +will build the existing project on your local machine. -$ yarn +**Note:-** +- Before using yarn build , make sure you are inside the main project folder. +if your current location on terminal is not inside the project folder then run, +```sh +$ cd website +``` +then build script. + +## Run +Now the main fun begins!! we will be using docusaurus for running and delployng our website on local server. + +One can run , +```sh $ yarn start ``` +to start server or + +- To start the server on a specified port say ```3000``` try , +```sh + +$ docusaurus start --port +``` +this will start the server on the default port ```3000``` + +One can also select a server to be accessible externally they can try +```sh +$ yarn docusaurus serve --host 0.0.0.0 +``` +or +```sh +$ yarn run start -- --host 0.0.0.0 +``` +you can run the dev server on ```0.0.0.0``` to make it listen on the local IP. + +**Note:-** +- Before starting server, make sure you are inside the main project folder. Review comment: No need ########## File path: README.md ########## @@ -7,14 +6,75 @@ The website of [Apache APISIX®](https://apisix.apache.org/), a cloud-native mic If you want to write a blog or fix some blog-related issues, please read [Apache APISIX Blog Contributing Guide](http://apisix.apache.org/docs/general/blog) first. Then create a pull request. -## Usage +--- + +# Contribution +Refer these basic steps to contribute. +## Contents +- [Environment-SetUp](#clone) +- [Start server](#build) +- [Run](#run) +- [Reference](#reference) + +## Clone +To run & test the project locally on your machine , you need to clone it locally. +you can do it by :- ```sh +$ git clone https://github.com/apache/apisix-website.git $ cd website +``` +## Build +```sh +$ yarn build +``` +will build the existing project on your local machine. -$ yarn +**Note:-** +- Before using yarn build , make sure you are inside the main project folder. +if your current location on terminal is not inside the project folder then run, +```sh +$ cd website +``` +then build script. + +## Run +Now the main fun begins!! we will be using docusaurus for running and delployng our website on local server. + +One can run , +```sh $ yarn start ``` +to start server or + +- To start the server on a specified port say ```3000``` try , +```sh + +$ docusaurus start --port +``` +this will start the server on the default port ```3000``` + +One can also select a server to be accessible externally they can try +```sh +$ yarn docusaurus serve --host 0.0.0.0 +``` +or +```sh +$ yarn run start -- --host 0.0.0.0 +``` +you can run the dev server on ```0.0.0.0``` to make it listen on the local IP. + +**Note:-** +- Before starting server, make sure you are inside the main project folder. +if your current location on terminal is not inside the project folder then run, +```sh +$ cd website +``` +then start server. + +## Reference +For knowing more about ```Docusaurus``` & it's developement using ```yarn``` +One can visit the documentation of Docusaurus at [Docs](https://docusaurus.io/docs/cli) Review comment: No need until here. ########## File path: README.md ########## @@ -7,14 +6,75 @@ The website of [Apache APISIX®](https://apisix.apache.org/), a cloud-native mic If you want to write a blog or fix some blog-related issues, please read [Apache APISIX Blog Contributing Guide](http://apisix.apache.org/docs/general/blog) first. Then create a pull request. -## Usage +--- + +# Contribution +Refer these basic steps to contribute. +## Contents +- [Environment-SetUp](#clone) +- [Start server](#build) +- [Run](#run) +- [Reference](#reference) + +## Clone +To run & test the project locally on your machine , you need to clone it locally. +you can do it by :- ```sh +$ git clone https://github.com/apache/apisix-website.git $ cd website +``` +## Build +```sh +$ yarn build +``` +will build the existing project on your local machine. -$ yarn +**Note:-** +- Before using yarn build , make sure you are inside the main project folder. +if your current location on terminal is not inside the project folder then run, +```sh +$ cd website +``` +then build script. + +## Run +Now the main fun begins!! we will be using docusaurus for running and delployng our website on local server. + +One can run , +```sh $ yarn start ``` +to start server or + +- To start the server on a specified port say ```3000``` try , +```sh + +$ docusaurus start --port +``` +this will start the server on the default port ```3000``` + +One can also select a server to be accessible externally they can try +```sh +$ yarn docusaurus serve --host 0.0.0.0 +``` +or +```sh +$ yarn run start -- --host 0.0.0.0 +``` +you can run the dev server on ```0.0.0.0``` to make it listen on the local IP. Review comment: Also need improve. ########## File path: README.md ########## @@ -7,14 +6,75 @@ The website of [Apache APISIX®](https://apisix.apache.org/), a cloud-native mic If you want to write a blog or fix some blog-related issues, please read [Apache APISIX Blog Contributing Guide](http://apisix.apache.org/docs/general/blog) first. Then create a pull request. -## Usage +--- + +# Contribution +Refer these basic steps to contribute. +## Contents +- [Environment-SetUp](#clone) +- [Start server](#build) +- [Run](#run) +- [Reference](#reference) + +## Clone +To run & test the project locally on your machine , you need to clone it locally. +you can do it by :- ```sh +$ git clone https://github.com/apache/apisix-website.git $ cd website +``` +## Build +```sh +$ yarn build +``` +will build the existing project on your local machine. -$ yarn +**Note:-** +- Before using yarn build , make sure you are inside the main project folder. Review comment: ```suggestion Before using yarn build , make sure you are inside the main project folder. ``` ########## File path: README.md ########## @@ -7,14 +6,75 @@ The website of [Apache APISIX®](https://apisix.apache.org/), a cloud-native mic If you want to write a blog or fix some blog-related issues, please read [Apache APISIX Blog Contributing Guide](http://apisix.apache.org/docs/general/blog) first. Then create a pull request. -## Usage +--- + +# Contribution +Refer these basic steps to contribute. +## Contents +- [Environment-SetUp](#clone) +- [Start server](#build) +- [Run](#run) +- [Reference](#reference) + +## Clone +To run & test the project locally on your machine , you need to clone it locally. +you can do it by :- ```sh +$ git clone https://github.com/apache/apisix-website.git $ cd website +``` +## Build +```sh +$ yarn build +``` +will build the existing project on your local machine. -$ yarn +**Note:-** +- Before using yarn build , make sure you are inside the main project folder. +if your current location on terminal is not inside the project folder then run, +```sh +$ cd website +``` +then build script. + +## Run +Now the main fun begins!! we will be using docusaurus for running and delployng our website on local server. + +One can run , +```sh $ yarn start ``` +to start server or + +- To start the server on a specified port say ```3000``` try , +```sh + +$ docusaurus start --port +``` +this will start the server on the default port ```3000``` + +One can also select a server to be accessible externally they can try Review comment: Need improve. ########## File path: README.md ########## @@ -7,14 +6,75 @@ The website of [Apache APISIX®](https://apisix.apache.org/), a cloud-native mic If you want to write a blog or fix some blog-related issues, please read [Apache APISIX Blog Contributing Guide](http://apisix.apache.org/docs/general/blog) first. Then create a pull request. -## Usage +--- + +# Contribution +Refer these basic steps to contribute. +## Contents +- [Environment-SetUp](#clone) +- [Start server](#build) +- [Run](#run) +- [Reference](#reference) + +## Clone +To run & test the project locally on your machine , you need to clone it locally. +you can do it by :- ```sh +$ git clone https://github.com/apache/apisix-website.git $ cd website +``` +## Build +```sh +$ yarn build +``` +will build the existing project on your local machine. -$ yarn +**Note:-** +- Before using yarn build , make sure you are inside the main project folder. +if your current location on terminal is not inside the project folder then run, Review comment: Add a line above. ```suggestion If your current location on terminal is not inside the project folder then run, ``` ########## File path: README.md ########## @@ -7,14 +6,75 @@ The website of [Apache APISIX®](https://apisix.apache.org/), a cloud-native mic If you want to write a blog or fix some blog-related issues, please read [Apache APISIX Blog Contributing Guide](http://apisix.apache.org/docs/general/blog) first. Then create a pull request. -## Usage +--- + +# Contribution +Refer these basic steps to contribute. +## Contents +- [Environment-SetUp](#clone) +- [Start server](#build) +- [Run](#run) +- [Reference](#reference) + +## Clone +To run & test the project locally on your machine , you need to clone it locally. +you can do it by :- ```sh +$ git clone https://github.com/apache/apisix-website.git $ cd website +``` +## Build +```sh +$ yarn build +``` +will build the existing project on your local machine. -$ yarn +**Note:-** +- Before using yarn build , make sure you are inside the main project folder. +if your current location on terminal is not inside the project folder then run, +```sh +$ cd website +``` +then build script. Review comment: Maybe we can del this line. Keep it simple. ########## File path: README.md ########## @@ -7,14 +6,75 @@ The website of [Apache APISIX®](https://apisix.apache.org/), a cloud-native mic If you want to write a blog or fix some blog-related issues, please read [Apache APISIX Blog Contributing Guide](http://apisix.apache.org/docs/general/blog) first. Then create a pull request. -## Usage +--- + +# Contribution +Refer these basic steps to contribute. +## Contents +- [Environment-SetUp](#clone) +- [Start server](#build) +- [Run](#run) +- [Reference](#reference) + +## Clone +To run & test the project locally on your machine , you need to clone it locally. +you can do it by :- ```sh +$ git clone https://github.com/apache/apisix-website.git $ cd website +``` +## Build +```sh +$ yarn build +``` +will build the existing project on your local machine. -$ yarn +**Note:-** +- Before using yarn build , make sure you are inside the main project folder. +if your current location on terminal is not inside the project folder then run, +```sh +$ cd website +``` +then build script. + +## Run +Now the main fun begins!! we will be using docusaurus for running and delployng our website on local server. + +One can run , +```sh $ yarn start ``` +to start server or + +- To start the server on a specified port say ```3000``` try , +```sh + +$ docusaurus start --port +``` +this will start the server on the default port ```3000``` + +One can also select a server to be accessible externally they can try +```sh +$ yarn docusaurus serve --host 0.0.0.0 +``` +or +```sh +$ yarn run start -- --host 0.0.0.0 +``` +you can run the dev server on ```0.0.0.0``` to make it listen on the local IP. Review comment: ```suggestion you can run the dev server on `0.0.0.0` to make it listen on the local IP. ``` ########## File path: README.md ########## @@ -7,14 +6,75 @@ The website of [Apache APISIX®](https://apisix.apache.org/), a cloud-native mic If you want to write a blog or fix some blog-related issues, please read [Apache APISIX Blog Contributing Guide](http://apisix.apache.org/docs/general/blog) first. Then create a pull request. -## Usage +--- + +# Contribution +Refer these basic steps to contribute. +## Contents +- [Environment-SetUp](#clone) +- [Start server](#build) +- [Run](#run) +- [Reference](#reference) + +## Clone +To run & test the project locally on your machine , you need to clone it locally. +you can do it by :- ```sh +$ git clone https://github.com/apache/apisix-website.git $ cd website +``` +## Build +```sh +$ yarn build +``` +will build the existing project on your local machine. -$ yarn +**Note:-** +- Before using yarn build , make sure you are inside the main project folder. +if your current location on terminal is not inside the project folder then run, +```sh +$ cd website +``` +then build script. + +## Run +Now the main fun begins!! we will be using docusaurus for running and delployng our website on local server. + +One can run , +```sh $ yarn start ``` +to start server or Review comment: No need ########## File path: README.md ########## @@ -7,14 +6,75 @@ The website of [Apache APISIX®](https://apisix.apache.org/), a cloud-native mic If you want to write a blog or fix some blog-related issues, please read [Apache APISIX Blog Contributing Guide](http://apisix.apache.org/docs/general/blog) first. Then create a pull request. -## Usage +--- + +# Contribution +Refer these basic steps to contribute. +## Contents +- [Environment-SetUp](#clone) +- [Start server](#build) +- [Run](#run) +- [Reference](#reference) + +## Clone +To run & test the project locally on your machine , you need to clone it locally. +you can do it by :- ```sh +$ git clone https://github.com/apache/apisix-website.git $ cd website +``` +## Build +```sh +$ yarn build +``` +will build the existing project on your local machine. -$ yarn +**Note:-** +- Before using yarn build , make sure you are inside the main project folder. +if your current location on terminal is not inside the project folder then run, +```sh +$ cd website +``` +then build script. + +## Run +Now the main fun begins!! we will be using docusaurus for running and delployng our website on local server. + +One can run , Review comment: No need. ########## File path: README.md ########## @@ -7,14 +6,75 @@ The website of [Apache APISIX®](https://apisix.apache.org/), a cloud-native mic If you want to write a blog or fix some blog-related issues, please read [Apache APISIX Blog Contributing Guide](http://apisix.apache.org/docs/general/blog) first. Then create a pull request. -## Usage +--- + +# Contribution +Refer these basic steps to contribute. +## Contents +- [Environment-SetUp](#clone) +- [Start server](#build) +- [Run](#run) +- [Reference](#reference) + +## Clone +To run & test the project locally on your machine , you need to clone it locally. +you can do it by :- ```sh +$ git clone https://github.com/apache/apisix-website.git $ cd website +``` +## Build +```sh +$ yarn build +``` +will build the existing project on your local machine. -$ yarn +**Note:-** +- Before using yarn build , make sure you are inside the main project folder. +if your current location on terminal is not inside the project folder then run, +```sh +$ cd website +``` +then build script. + +## Run +Now the main fun begins!! we will be using docusaurus for running and delployng our website on local server. + +One can run , +```sh $ yarn start ``` +to start server or + +- To start the server on a specified port say ```3000``` try , +```sh + +$ docusaurus start --port +``` +this will start the server on the default port ```3000``` + +One can also select a server to be accessible externally they can try +```sh +$ yarn docusaurus serve --host 0.0.0.0 +``` +or Review comment: No need until line 65 ########## File path: README.md ########## @@ -7,14 +6,75 @@ The website of [Apache APISIX®](https://apisix.apache.org/), a cloud-native mic If you want to write a blog or fix some blog-related issues, please read [Apache APISIX Blog Contributing Guide](http://apisix.apache.org/docs/general/blog) first. Then create a pull request. -## Usage +--- + +# Contribution +Refer these basic steps to contribute. +## Contents +- [Environment-SetUp](#clone) +- [Start server](#build) +- [Run](#run) +- [Reference](#reference) + +## Clone +To run & test the project locally on your machine , you need to clone it locally. +you can do it by :- ```sh +$ git clone https://github.com/apache/apisix-website.git $ cd website +``` +## Build +```sh +$ yarn build +``` +will build the existing project on your local machine. -$ yarn +**Note:-** +- Before using yarn build , make sure you are inside the main project folder. +if your current location on terminal is not inside the project folder then run, +```sh +$ cd website +``` +then build script. + +## Run +Now the main fun begins!! we will be using docusaurus for running and delployng our website on local server. + +One can run , +```sh $ yarn start ``` +to start server or + +- To start the server on a specified port say ```3000``` try , Review comment: ```suggestion To start the server on a specified port say ```3000``` try , ``` ########## File path: README.md ########## @@ -7,14 +6,75 @@ The website of [Apache APISIX®](https://apisix.apache.org/), a cloud-native mic If you want to write a blog or fix some blog-related issues, please read [Apache APISIX Blog Contributing Guide](http://apisix.apache.org/docs/general/blog) first. Then create a pull request. -## Usage +--- + +# Contribution +Refer these basic steps to contribute. +## Contents +- [Environment-SetUp](#clone) +- [Start server](#build) +- [Run](#run) +- [Reference](#reference) + +## Clone +To run & test the project locally on your machine , you need to clone it locally. +you can do it by :- ```sh +$ git clone https://github.com/apache/apisix-website.git $ cd website +``` +## Build +```sh +$ yarn build +``` +will build the existing project on your local machine. -$ yarn +**Note:-** +- Before using yarn build , make sure you are inside the main project folder. +if your current location on terminal is not inside the project folder then run, +```sh +$ cd website Review comment: ```suggestion $ cd apisix-website ``` -- 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: [email protected] For queries about this service, please contact Infrastructure at: [email protected]
