Skip to content

Commit ca5b00a

Browse files
authored
doc: Change doc base on Debra Chen advices (#65)
1 parent 7d37d2e commit ca5b00a

1 file changed

Lines changed: 10 additions & 7 deletions

File tree

docs/source/index.rst

Lines changed: 10 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ PyDolphinScheduler
1919
==================
2020

2121
**PyDolphinScheduler** is Python API for `Apache DolphinScheduler <https://dolphinscheduler.apache.org>`_,
22-
which allow you definition your workflow by Python code, aka workflow-as-codes.
22+
which allow you define your workflow by Python code, aka workflow-as-codes.
2323

2424
History
2525
-------
@@ -33,7 +33,7 @@ The reason why we seperated is for the following reasons:
3333
- **Clear responsibility**: The code base of PyDolphinScheduler is independent of DolphinScheduler, it has its
3434
own users and developers, CI and test cases, even the language is different.
3535
- **Independent release cycle**: PyDolphinScheduler is a SDK, it should be released independently of DolphinScheduler.
36-
before we seperated, we have to release PyDolphinScheduler every time when DolphinScheduler. This brings two
36+
before we seperated, we have to release PyDolphinScheduler every time when DolphinScheduler released. This brings two
3737
main problems:
3838

3939
- DolphinScheduler release cycle is a little long for PyDolphinScheduler, because PyDolphinScheduler is a new subproject
@@ -60,12 +60,13 @@ At Nov 7, 2022 we seperated PyDolphinScheduler. And before that, PyDolphinSchedu
6060
So the version of PyDolphinScheduler is the same as DolphinScheduler, for example PyDolphinScheduler 2.0.5 is matched with
6161
DolphinScheduler 2.0.5. For more details about why we seperated PyDolphinScheduler, please refer to `History`_.
6262

63-
And after we seperated, we will release PyDolphinScheduler independently, and the version of PyDolphinScheduler will
64-
be different with DolphinScheduler, and some of PyDolphinScheduler version will not match multiple DolphinScheduler version
65-
because the code do not change in PyDolphinScheduler, and we will release PyDolphinScheduler but support multiple DolphinScheduler
66-
version due to we do not change
63+
After being separated from the DolphinScheduler repository, PyDolphinScheduler will be released independently,
64+
and the version of PyDolphinScheduler will not correspond to the version of DolphinScheduler, which means some
65+
of the PyDolphinScheduler versions will correspond to multiple DolphinScheduler versions when there is no
66+
change in the PythonGateway code. While part of the code of PyDolphinScheduler will only correspond to one
67+
version of DolphinScheduler, if the code of the next version of
6768
`PythonGateway <https://github.com/apache/dolphinscheduler/blob/dev/dolphinscheduler-api/src/main/java/org/apache/dolphinscheduler/api/python/PythonGateway.java>`_
68-
code.
69+
has changed.
6970

7071
We will release PyDolphinScheduler version **4.0.0** as the first version after we seperated, so please be ware of when you
7172
use PyDolphinScheduler above version 4.0.0.
@@ -83,6 +84,8 @@ use PyDolphinScheduler above version 4.0.0.
8384
+-----------------------------+----------------------------+---------------------+
8485
| above 3.1.0 and prior 3.1.2 | 3.1.0 | before we seperated |
8586
+-----------------------------+----------------------------+---------------------+
87+
| above 3.1.2 and prior 3.1.4 | 4.0.0 | |
88+
+-----------------------------+----------------------------+---------------------+
8689

8790

8891
Content

0 commit comments

Comments
 (0)