Skip to content

Commit c897b64

Browse files
SbloodySSbloodyS
authored
[Doc-18120] Remove irrelevant windows system documents (#18121)
1 parent f5028d5 commit c897b64

6 files changed

Lines changed: 27 additions & 51 deletions

File tree

‎docs/docs/en/contribute/join/document.md‎

Lines changed: 0 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -20,15 +20,6 @@ git clone https://github.com/<your-github-user-name>/dolphinscheduler-website
2020
2.2. Run `./scripts/prepare_docs.sh` prepare all related resources, for more information you could see [how prepare script work](https://github.com/apache/dolphinscheduler-website/blob/master/HOW_PREPARE_WORK.md)
2121
3. Run `yarn generate` in the root directory to format and prepare the data.
2222
4. Run `yarn dev` in the root directory to start a local server, you will see the website in 'http://localhost:3000'.
23-
24-
```
25-
Note: if you clone the code in Windows, not Mac or Linux. Please read the details below.
26-
If you execute the commands like the two steps above, you will get the exception "UnhandledPromiseRejectionWarning: Error: EPERM: operation not permitted, symlink '2.0.3' -> 'latest'".
27-
If you get the exception "Can't resolve 'antd' in xxx",you can run `yarn add antd` and `yarn install`.
28-
Because the `./scripts/prepare_docs.sh` command requires a Linux environment, if you are on a Windows system, you can use WSL to complete this step.
29-
When you encounter this problem. You can run the two steps in cmd.exe as an administrator on your Windows system.
30-
```
31-
3223
5. Run `yarn build` to build source code, this will automatically generate a directory called `build`, wait for the execution to complete and into `build` directory.
3324
6. Verify your change locally: `python -m SimpleHTTPServer 8000`, when your python version is 3 use :`python3 -m http.server 8000` instead.
3425

‎docs/docs/en/contribute/join/review.md‎

Lines changed: 13 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -36,20 +36,19 @@ Review Issues means discuss [Issues][all-issues] in GitHub and give suggestions
3636
In addition give suggestion, add label for issue is also important during review. The labeled issues can be retrieved
3737
better, which convenient for further processing. An issue can with more than one label. Common issue categories are:
3838

39-
| Label | Meaning |
40-
|------------------------------------------|--------------------------------|
41-
| [UI][label-ui] | UI and front-end related |
42-
| [security][label-security] | Security Issue |
43-
| [user experience][label-user-experience] | User experience Issue |
44-
| [development][label-development] | Development Issue |
45-
| [Python][label-python] | Python Issue |
46-
| [plug-in][label-plug-in] | Plug-in Issue |
47-
| [document][label-document] | Document Issue |
48-
| [docker][label-docker] | Docker Issue |
49-
| [need verify][label-need-verify] | Need verify Issue |
50-
| [e2e][label-e2e] | E2E Issue |
51-
| [win-os][label-win-os] | windows operating system Issue |
52-
| [suggestion][label-suggestion] | Give suggestion to us |
39+
| Label | Meaning |
40+
|------------------------------------------|--------------------------|
41+
| [UI][label-ui] | UI and front-end related |
42+
| [security][label-security] | Security Issue |
43+
| [user experience][label-user-experience] | User experience Issue |
44+
| [development][label-development] | Development Issue |
45+
| [Python][label-python] | Python Issue |
46+
| [plug-in][label-plug-in] | Plug-in Issue |
47+
| [document][label-document] | Document Issue |
48+
| [docker][label-docker] | Docker Issue |
49+
| [need verify][label-need-verify] | Need verify Issue |
50+
| [e2e][label-e2e] | E2E Issue |
51+
| [suggestion][label-suggestion] | Give suggestion to us |
5352

5453
Beside classification, label could also set the priority of Issues. The higher the priority, the more attention pay
5554
in the community, the easier it is to be fixed or implemented. The priority label are as follows

‎docs/docs/en/guide/start/docker.md‎

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -46,8 +46,6 @@ $ tar -zxf apache-dolphinscheduler-"${DOLPHINSCHEDULER_VERSION}"-src.tar.gz
4646
# Going to docker-compose's location
4747
# For Mac or Linux users
4848
$ cd apache-dolphinscheduler-"${DOLPHINSCHEDULER_VERSION}"-src/deploy/docker
49-
# For Windows users, you should run command `cd apache-dolphinscheduler-"${DOLPHINSCHEDULER_VERSION}"-src\deploy\docker`
50-
5149
# Initialize the database, use profile schema
5250
$ docker-compose --profile schema up -d
5351

‎docs/docs/zh/contribute/join/document.md‎

Lines changed: 0 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -22,17 +22,7 @@ git clone https://github.com/<your-github-user-name>/dolphinscheduler-website
2222
- 运行 `./scripts/prepare_docs.sh` 准备所有相关资源
2323
3. 在根目录下运行 `yarn generate` 来格式化和准备数据。
2424
4. 在根目录下运行 `yarn dev` 启动本地服务器，你可以在 http://localhost:3000 查看网站。
25-
26-
```
27-
注意：如果您在 Windows 而非 Mac 或 Linux 中克隆代码。请阅读下面的详细信息。
28-
如果执行上述两个步骤中的命令，将出现异常 “UnhandledPromiseRejectionWarning.Error:”： Error： EPERM: operation not permitted, symlink ‘2.0.3’ -> ‘latest’".
29-
如果出现异常 “Can't resolve ‘antd’ in xxx”，你可以运行 `yarn add antd` 和 `yarn install`。
30-
因为这两个步骤运行的命令`./scripts/prepare_docs.sh`应该是 Linux 环境，所以如果你是 Windows 系统，可以使用 WSL 来完成。
31-
遇到这个问题时。你可以以管理员身份运行 cmd.exe 中的两个步骤。
32-
```
33-
3425
5. 运行 `yarn build` 来构建源代码，此时会自动生成一个名为 `build` 的目录，等待执行完成后进入 `build` 目录。
35-
3626
6. 在本地验证你的更改：`python -m SimpleHTTPServer 8000`，当 Python 版本为 3 时，请使用：`python3 -m http.server 8000`。
3727

3828
如果本地安装了更高版本的 Node，可以考虑使用 `nvm` 来允许不同版本的 Node 在你的计算机上运行。

‎docs/docs/zh/contribute/join/review.md‎

Lines changed: 13 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -31,20 +31,19 @@ Review Issues 是指在 GitHub 中参与 [Issues][all-issues] 的讨论，并在
3131

3232
除了个 issue 建议之外，给 Issue 分类也是非常重要的一个工作。分类后的 Issue 可以更好的被检索，为以后进一步处理提供便利。一个 Issue 可以被打上多个标签，常见的 Issue 分类有
3333

34-
| 标签 | 标签代表的情况 |
35-
|------------------------------------------|-----------------------|
36-
| [UI][label-ui] | UI 以及前端相关的 Issue |
37-
| [security][label-security] | 安全相关的 Issue |
38-
| [user experience][label-user-experience] | 用户体验相关的 Issue |
39-
| [development][label-development] | 开发者相关的 Issue |
40-
| [Python][label-python] | Python 相关的 Issue |
41-
| [plug-in][label-plug-in] | 插件相关的 Issue |
42-
| [document][label-document] | 文档相关的 Issue |
43-
| [docker][label-docker] | docker 相关的 Issue |
44-
| [need verify][label-need-verify] | Issue 需要被验证 |
45-
| [e2e][label-e2e] | e2e 相关的 Issue |
46-
| [win-os][label-win-os] | windows 操作系统相关的 Issue |
47-
| [suggestion][label-suggestion] | Issue 为项目提出了建议 |
34+
| 标签 | 标签代表的情况 |
35+
|------------------------------------------|------------------|
36+
| [UI][label-ui] | UI 以及前端相关的 Issue |
37+
| [security][label-security] | 安全相关的 Issue |
38+
| [user experience][label-user-experience] | 用户体验相关的 Issue |
39+
| [development][label-development] | 开发者相关的 Issue |
40+
| [Python][label-python] | Python 相关的 Issue |
41+
| [plug-in][label-plug-in] | 插件相关的 Issue |
42+
| [document][label-document] | 文档相关的 Issue |
43+
| [docker][label-docker] | docker 相关的 Issue |
44+
| [need verify][label-need-verify] | Issue 需要被验证 |
45+
| [e2e][label-e2e] | e2e 相关的 Issue |
46+
| [suggestion][label-suggestion] | Issue 为项目提出了建议 |
4847

4948
标签除了分类之外，还能区分 Issue 的优先级，优先级越高的标签越重要，越容易被重视，并会尽快被修复或者实现，优先级的标签如下
5049

‎docs/docs/zh/guide/start/docker.md‎

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ $ docker run --name dolphinscheduler-standalone-server -p 12345:12345 -p 25333:2
3131

3232
使用 docker-compose 启动服务相比 standalone-server 的优点是 DolphinScheduler 的各个是独立的容器和进程，相互影响降到最小，且能够在
3333
服务重启的时候保留元数据（如需要挂载到本地路径需要做指定）。他更健壮，能保证用户体验更加完整的 DolphinScheduler 服务。这种方式需要先安装
34-
[docker-compose](https://docs.docker.com/compose/install/)，链接适用于 Mac，Linux，Windows。
34+
[docker-compose](https://docs.docker.com/compose/install/)，链接适用于 Mac，Linux。
3535

3636
确保 docker-compose 顺利安装后，需要获取 `docker-compose.yaml` 文件，通过[下载页面](https://dolphinscheduler.apache.org/en-us/download/<version>)
3737
下载对应版本源码包可能是最快的方法，当下载完源码后就可以运行命令进行部署了。
@@ -41,7 +41,6 @@ $ DOLPHINSCHEDULER_VERSION=<version>
4141
$ tar -zxf apache-dolphinscheduler-"${DOLPHINSCHEDULER_VERSION}"-src.tar.gz
4242
# Mac Linux 用户
4343
$ cd apache-dolphinscheduler-"${DOLPHINSCHEDULER_VERSION}"-src/deploy/docker
44-
# Windows 用户, `cd apache-dolphinscheduler-"${DOLPHINSCHEDULER_VERSION}"-src\deploy\docker`
4544

4645
# 如果需要初始化或者升级数据库结构，需要指定profile为schema
4746
$ docker-compose --profile schema up -d

0 commit comments

Comments
 (0)