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/04/02 07:22:40 UTC
[GitHub] [apisix-website] yzeng25 commented on a change in pull request #1001: Fixed #989
yzeng25 commented on a change in pull request #1001:
URL: https://github.com/apache/apisix-website/pull/1001#discussion_r841030991
##########
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.
Review comment:
```suggestion
To build the existing project on your local machine, run this command.
```sh
yarn build
```
##########
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:
Could you delete `$` sign for each command?
```suggestion
git clone https://github.com/apache/apisix-website.git
cd 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:-**
+- 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:
Agree. For the up and running part, I think two commands are enough.
`yarn start`
`yarn start -- -- locale zh`
For the remaining materials in up and running part, unless you tried and felt really necessary to add, you can delete them.
##########
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
```
Review comment:
You can add some more description in this part.
Normally this works for en-US environment.
```suggestion
```sh
yarn start
```
But for zh-CN enviroment, we need a similar command
```shell
yarn start -- -- locale zh
```
##########
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:
Agree.
##########
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:
Agree.
##########
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:
`To run and 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.
+
+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```
Review comment:
```suggestion
For knowing more about ```Docusaurus``` and it is developement using ```yarn```
```
##########
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:
Agree.
--
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