Description

For now, we documentation is not easy enough to read and maintain. I think documentation is also an important for OSS, it would be

General

• Sperate user_muanl/user_manal to multiple file with different level. https://github.com/apache/dolphinscheduler-website/pull/453
• Add directory for our image file, start this task until all we markdown document is done.
• Find a way to use codebase repo directory icon files instead of copy-paste

Content

DRY

• remove duplicate content in the document, for example in installation we have duplicate download mysql dependent
• Many parameters of task have same definition, find a way to handle it. maybe we could see what github/doc do, https://github.com/github/docs

Missing document

• Chinese translation for ambari integration. @lukairui https://github.com/apache/dolphinscheduler-website/pull/494 Our community going to drop support of Apache Ambari in the further, so we do not need this anymore.
• How to contribute to our document, including dev and older doc.
• https://github.com/apache/dolphinscheduler/issues/6611
• 🔥 Missing Task: we missing some of our tasks in doc
  • SQOOP
  • condition. https://github.com/apache/dolphinscheduler-website/pull/453
  • switch. https://github.com/apache/dolphinscheduler/issues/6561
  • waterdrop
  • pigeon. https://github.com/apache/dolphinscheduler-website/pull/453
  • Task conditions screenshot https://github.com/apache/dolphinscheduler-website/pull/461
• 🔥 Missing alert plugin
  • Alert plugin dingtalk apache/dolphinscheduler-website#650
  • Alert plugin email
  • Alert plugin feishu
  • Alert plugin http
  • Alert plugin script
  • Alert plugin slack
  • Alert plugin wechat
• 🔥 Missing datasource plugin
  • Alert plugin clickhouse
  • Alert plugin db2
  • Alert plugin oracle
  • Alert plugin sqlserver
• Inside DolphinScheduler
  • How master node run
  • How worker node run
  • How master and worker community, and task lifecycle
• DolphinScheduler plugins development
• DolphinScheduler API
  • API docs and example, provider curl command line would be better.

To be classify

• user_doc/globalParam https://github.com/apache/dolphinscheduler-website/pull/472
• All the spi document for develpment. https://github.com/apache/dolphinscheduler/issues/6577
• Unify dev-run and dev-quick-start https://github.com/apache/dolphinscheduler-website/pull/472

To be update

• For now, task name much unify in the project
• introduction.md
• 🔥 Installation https://github.com/apache/dolphinscheduler-website/pull/465
• 🔥 Task Usage: we should add basic usage, example, notict about tasks
  • #8016
  • #8017
  • #8018
  • #8019
  • #8020
  • #8021
  • #8022
  • #8023
  • #8024
  • #8025
  • #8026
  • #8027
  • #8028
  • #8029
  • #8030
  • #8031
• Picture in English doc have Chinese content
  • design，https://github.com/apache/dolphinscheduler/issues/7496
• architecture-design
  • Task queue. https://github.com/apache/dolphinscheduler/discussions/7835
  • Architecture diagram. https://github.com/apache/dolphinscheduler/discussions/7306
• #7870

Syntax

• Use markdown table syntax instead of html table syntax <table>
• Find a better way to show our picture, for now it use html syntax in markdown file. I find our it can be show use markdown image syntax, such as this line

CI

• Add markdown link for our document
• Add chinese/english spelling ci for our doc
• Add document preview generation for each PR, example https://github.com/sqlfluff/sqlfluff/issues/808#issuecomment-787493894 . I think it really important to reduce doc build error, such as this PR https://github.com/apache/dolphinscheduler-website/pull/454, we get error dev leading page url make all our document error.
• Add doc style check for our documentation, inspired by https://github.com/apache/dolphinscheduler-website/pull/463#discussion_r734245581. maybe we could use https://github.com/tidb-incubator/zh.md