You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@inlong.apache.org by do...@apache.org on 2021/07/08 02:48:10 UTC

[incubator-inlong-website] branch master updated: [INLONG-682] Adjust the quick_start content of website. (#87)

This is an automated email from the ASF dual-hosted git repository.

dockerzhang pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/incubator-inlong-website.git


The following commit(s) were added to refs/heads/master by this push:
     new 807c107  [INLONG-682] Adjust the quick_start content of website. (#87)
807c107 is described below

commit 807c107b7cda7e2aafc39e5dab1616dbf8539904
Author: Daniel <le...@outlook.com>
AuthorDate: Thu Jul 8 10:48:04 2021 +0800

    [INLONG-682] Adjust the quick_start content of website. (#87)
    
    * [INLONG-682] Adjust the quick_start content of website.
    
    * [INLONG-682] Adjust the quick_start content of website.
---
 docs/en-us/modules/{console => website}/quick_start.md | 10 +++++-----
 docs/zh-cn/modules/{console => website}/quick_start.md | 12 ++++++------
 2 files changed, 11 insertions(+), 11 deletions(-)

diff --git a/docs/en-us/modules/console/quick_start.md b/docs/en-us/modules/website/quick_start.md
similarity index 82%
rename from docs/en-us/modules/console/quick_start.md
rename to docs/en-us/modules/website/quick_start.md
index fb6a558..fd75f06 100644
--- a/docs/en-us/modules/console/quick_start.md
+++ b/docs/en-us/modules/website/quick_start.md
@@ -1,4 +1,4 @@
-## Before
+## Environment
 
 You should check that `nodejs >= 12.0` is installed.
 
@@ -15,9 +15,7 @@ If the server runs successfully, the browser will open [http://localhost:8080](h
 If you edit, the page will reload.
 You will also see any lint errors in the console.
 
-### Note
-
-The start of the web server depends on the back-end server api interface.
+The start of the web server depends on the back-end server `manger api` interface.
 
 You should start the backend server first, and then set the variable `target` in `/inlong-website/src/setupProxy.js` to the address of the api service.
 
@@ -30,7 +28,9 @@ For more information, see the section on [Running Tests](https://create-react-ap
 
 ## Build and deploy
 
-Run `npm run build` or `yarn build`
+First, make sure that the project has run `npm install` or `yarn install` to install `node_modules`.
+
+Run `npm run build` or `yarn build`.
 
 Build the application for production into the build folder.
 Better page performance can be obtained in the constructed production mode.
diff --git a/docs/zh-cn/modules/console/quick_start.md b/docs/zh-cn/modules/website/quick_start.md
similarity index 72%
rename from docs/zh-cn/modules/console/quick_start.md
rename to docs/zh-cn/modules/website/quick_start.md
index 457c55b..d170a64 100644
--- a/docs/zh-cn/modules/console/quick_start.md
+++ b/docs/zh-cn/modules/website/quick_start.md
@@ -1,4 +1,4 @@
-## 使用前
+## 环境准备
 
 应该检查 `nodejs >= 12.0` 已经安装。
 
@@ -15,11 +15,9 @@
 如果您进行编辑,页面将重新加载。
 您还将在控制台中看到任何 lint 错误。
 
-### 注意
+web服务器的启动依赖于后端服务 `manger api` 接口。
 
-web服务器的启动依赖于后端服务器api接口。
-
-您应该先启动后端服务器,然后将`/inlong-website/src/setupProxy.js` 中的变量`target` 设置为api服务的地址。
+您应该先启动后端服务器,然后将 `/inlong-website/src/setupProxy.js` 中的变量`target` 设置为api服务的地址。
 
 ## 测试
 
@@ -30,7 +28,9 @@ web服务器的启动依赖于后端服务器api接口。
 
 ## 构建和部署
 
-运行 `npm run build` 或 `yarn build`
+首先保证项目已运行过 `npm install` 或 `yarn install` 安装了 `node_modules`。
+
+运行 `npm run build` 或 `yarn build`。
 
 将用于生产的应用程序构建到构建文件夹。
 在构建后的生产模式下可以获得较好的页面性能。