You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardexpand all lines: doc/open_collective.md
+12-18
Original file line number
Diff line number
Diff line change
@@ -4,23 +4,22 @@ the tool for **stateful processing of your interdependent tasks** powered by:
4
4
-**python** batteries
5
5
-**doit** processing engine
6
6
7
-
doit is mature project started in 2008 by @shettino72 and maintained by him up to date. It already serves years in numerous projects to:
7
+
doit is mature project started in 2008 by @schettino72 and maintained by him up to date. It already serves years in numerous projects to:
8
8
9
9
- simplify cumbersome command line calls,
10
10
- automate complex data processing or typical project related actions,
11
11
- share unified way of doing things,
12
12
- optimize processing time by skipping things already done.
13
-
13
+
14
14
People often compare `doit` to tools like `make`, `grunt` or `gulp` but they always appreciate
15
15
16
16
- strong features and flexibility
17
17
- simplicity of authoring and ease of use
18
18
- python
19
-
19
+
20
20
# Current focus
21
-
There are two current priorities:
22
-
23
-
## A: Maintain existing codebase
21
+
22
+
## Maintain existing code-base
24
23
The aim is to **keep the product in shape and usable**.
25
24
26
25
Abandoned open-source project does not work for long. Thriving project requires a maintainer to keep list of issues and list of pull requests short.
@@ -29,24 +28,21 @@ Financial goal is 500 USD per month to allow the maintainer working few hours a
29
28
30
29
Main capacity shall be provided by @schettino72
31
30
32
-
## B: Refactor documentation
31
+
32
+
# Long term vision
33
+
34
+
## B: Rewrite documentation
33
35
The aim is to **lower initial learning barrier for newcomers to get them on board** and to **help pro-users to unlock more features and earn fame**.
34
36
35
37
Existing documentation is good as it served well existing users. But we can serve better.
36
-
Inspired by great talk [What nobody tells you about documentation](https://www.youtube.com/watch?v=t4vKPhjcMZg&t=4s) by Daniele Procida we plan to refactor the documentation into following parts:
38
+
Inspired by great talk [What nobody tells you about documentation](https://www.youtube.com/watch?v=t4vKPhjcMZg&t=4s) by Daniele Procida we plan to rewrite the documentation into following parts:
37
39
38
40
- Introduction (basic features overview)
39
41
- Quick start and tutorials
40
42
- Reference documentation
41
43
- Concepts
42
-
- Howtos
43
-
44
-
Financial goal is another 500 USD per month to allow documentation writer working few hours a week on documentation refactoring and maintenance.
45
-
46
-
Main capacity shall be provided by @vlcinsky.
44
+
- How-to's
47
45
48
-
# Long term vision
49
-
Assuming the A and B priorities are fulfilled, we shall look further on into future.
50
46
51
47
## C: Promote
52
48
We believe, many more users deserve `doit` and we shall help them to know about it.
@@ -56,16 +52,14 @@ Promotion may have form of:
56
52
- helping selected python projects to adopt doit as internal tool
57
53
- video presentations
58
54
- presentation(s) at pycon(s)
59
-
60
-
This is long term priority and there is no budget set for it at the moment.
55
+
61
56
62
57
## D: Launch doit task libraries
63
58
64
59
Grunt library has over 6000 tasks, gulp has over 3000 plug-ins.
65
60
66
61
`doit` has similar potential. E.g. [doit-py](https://github.com/pydoit/doit-py) covers python code specific tasks. Few lines of code in [dodo.py](https://github.com/pydoit/doit-py/blob/master/dodo.py) to lint the code; run the tests and measure coverage; build and upload package; spell, build and publish sphinx based documentation.
67
62
68
-
This is long term priority and there is no budget set for it at the moment.
0 commit comments