Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

The installation documentation is very unfriendly #16931

Closed
2 of 3 tasks
charlessws opened this issue Dec 29, 2024 · 2 comments
Closed
2 of 3 tasks

The installation documentation is very unfriendly #16931

charlessws opened this issue Dec 29, 2024 · 2 comments
Labels
wontfix This will not be worked on

Comments

@charlessws
Copy link

Search before asking

  • I had searched in the issues and found no similar feature requirement.

Description

对于想试用的新人来说,安装文档非常不友好,特别是对于ubuntu环境不熟悉的人来说,简直处处是坑。我按照https://dolphinscheduler.apache.org/zh-cn/docs/3.1.5/guide/installation/pseudo-cluster说明文档进行安装,发现几乎每1-2步都会遇到问题,在一步一步询问chatgpt 4o的情况下艰难求索,已经2天了,才进行到三分之二。我承认自己是ubuntu小白,为了安装试验项目临时学了一些ubuntu命令,但是对于想推动社区发展的广大用户来说,文档的重要性远远超过项目本身,希望大家能够共同努力,让这个开源项目真正造福大众,这样大众才能更有动力去反馈和改进。现把我发现的几个文档问题简单描述如下:

  1. “准备 DolphinScheduler 启动环境”这一部分应该放在文档最顶部。原因:如果直接按照“前置准备工作”操作,会所有需要前置安装的工具安装在目前登录的账户,但实际上应该安装在一个新的账户里。比如后续文档描述的:创建 dolphinscheduler 用户。
  2. 创建用户需使用 root 登录:useradd dolphinscheduler,这个指令前面应该加上sudo,或者告诉用户如何首先进入root账户。

  3. 修改目录权限,使得部署用户对二进制包解压后的 apache-dolphinscheduler--bin 目录有操作权限。chown -R dolphinscheduler:dolphinscheduler apache-dolphinscheduler--bin。这里的描述非常不清楚,应该说明把apache-dolphinscheduler-*-bin替换为二进制安装包解压后的文件名。

  4. 进入 zookeeper 的安装目录,将 zoo_sample.cfg 配置文件复制到 conf/zoo.cfg,并将 conf/zoo.cfg 中 dataDir 中的值改成 dataDir=./tmp/zookeeper。这里 zoo_sample.cfg配置文件在新版本中已经改变了。
  5. 修改 install_env.sh 文件。这个文件在哪?至今没找到
    以上只是一小部分,真的没法全列出来,太多了……

Documentation Links

No response

Are you willing to submit a PR?

  • Yes I am willing to submit a PR!

Code of Conduct

@github-actions github-actions bot changed the title 安装文档非常不友好 The installation documentation is very unfriendly Dec 29, 2024
Copy link

Search before asking

  • I had searched in the issues and found no similar feature requirement.

Description

For newcomers who want to try it out, the installation documentation is very unfriendly, especially for those who are not familiar with the Ubuntu environment. It is full of pitfalls. I installed it according to the instructions https://dolphinscheduler.apache.org/zh-cn/docs/3.1.5/guide/installation/pseudo-cluster. I found that I encountered problems almost every 1-2 steps. I asked step by step. I have been struggling with chatgpt 4o. It has been 2 days and only two-thirds of the way. I admit that I am a novice on Ubuntu. I temporarily learned some Ubuntu commands in order to install the pilot project. However, for the majority of users who want to promote the development of the community, the importance of documentation far exceeds the project itself. I hope that everyone can work together to make this open source The project truly benefits the public, so that the public can be more motivated to give feedback and improve. Now I will briefly describe several document problems I found as follows:

  1. The section "Preparing the DolphinScheduler startup environment" should be placed at the top of the document. Reason: If you directly follow the "preparatory work", all tools that require pre-installation will be installed in the account you are currently logged in, but in fact they should be installed in a new account. For example, as described in subsequent documents: Create the dolphinscheduler user.
  2. To create a user, you need to log in as root: useradd dolphinscheduler. This command should be preceded by sudo, or tell the user how to first enter the root account.

  3. Modify the directory permissions so that the deployment user has operating permissions on the apache-dolphinscheduler--bin directory after the binary package is decompressed. chown -R dolphinscheduler:dolphinscheduler apache-dolphinscheduler--bin. The description here is very unclear. It should be explained that apache-dolphinscheduler-*-bin is replaced with the file name after decompression of the binary installation package.

  4. Enter the installation directory of zookeeper, copy the zoo_sample.cfg configuration file to conf/zoo.cfg, and change the value of dataDir in conf/zoo.cfg to dataDir=./tmp/zookeeper. The zoo_sample.cfg configuration file has changed in the new version.
  5. Modify the install_env.sh file. Where is this file? Not found yet
    The above are just a small part. It’s really impossible to list them all. There are too many...

Documentation Links

No response

Are you willing to submit a PR?

  • Yes I am willing to submit a PR!

Code of Conduct

@SbloodyS
Copy link
Member

The use of third-party tools such as Linux does not belong to the scope of Dolphinscheduler, and should not be elaborated in the documentation.

@SbloodyS SbloodyS added wontfix This will not be worked on and removed Waiting for reply Waiting for reply document labels Dec 31, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
wontfix This will not be worked on
Projects
None yet
Development

No branches or pull requests

2 participants