Skip to content

Commit 8ff9c15

Browse files
committedFeb 11, 2018
doc: open-collective, move docs work to "long term vision".
1 parent bfe9a33 commit 8ff9c15

File tree

2 files changed

+22
-19
lines changed

2 files changed

+22
-19
lines changed
 

‎doc/dictionary.txt

+10-1
Original file line numberDiff line numberDiff line change
@@ -60,6 +60,7 @@
6060
0'
6161
2to3
6262
3d
63+
4s
6364
API
6465
ATCI
6566
BC3
@@ -139,6 +140,7 @@ TaskFailed
139140
TaskLoader
140141
Tpng
141142
Trento
143+
USD
142144
UptodateCalculator
143145
Uz
144146
VCS
@@ -292,6 +294,7 @@ pathlib
292294
pdb
293295
perl
294296
picklable
297+
pixelmap
295298
plugin
296299
plugins
297300
png
@@ -301,6 +304,7 @@ pos1
301304
pre
302305
prev
303306
printf
307+
procida
304308
programmatically
305309
pstats
306310
py
@@ -317,12 +321,15 @@ pytest
317321
python2
318322
python3
319323
quickstart
324+
refactor
320325
regex
321326
repr
322327
rst2s5
323328
runtests
324329
s'
325330
s5defs
331+
schettino
332+
schettino72
326333
schettino72
327334
scons
328335
selecttasks
@@ -335,6 +342,7 @@ sourcecode
335342
sourceforge
336343
sqlite3
337344
startswith
345+
stateful
338346
stderr
339347
stdlib
340348
stdout
@@ -344,6 +352,7 @@ sudo
344352
t1
345353
t2
346354
t3
355+
t4vKPhjcMZg
347356
tabcompletion
348357
task1
349358
task2
@@ -355,6 +364,7 @@ time'
355364
timedelta
356365
timestamp
357366
titlewithactions
367+
to's
358368
toc
359369
toctree
360370
tsetup
@@ -378,4 +388,3 @@ x'
378388
xxx
379389
xyz
380390
zsh
381-
pixelmap

‎doc/open_collective.md

+12-18
Original file line numberDiff line numberDiff line change
@@ -4,23 +4,22 @@ the tool for **stateful processing of your interdependent tasks** powered by:
44
- **python** batteries
55
- **doit** processing engine
66

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:
88

99
- simplify cumbersome command line calls,
1010
- automate complex data processing or typical project related actions,
1111
- share unified way of doing things,
1212
- optimize processing time by skipping things already done.
13-
13+
1414
People often compare `doit` to tools like `make`, `grunt` or `gulp` but they always appreciate
1515

1616
- strong features and flexibility
1717
- simplicity of authoring and ease of use
1818
- python
19-
19+
2020
# Current focus
21-
There are two current priorities:
22-
23-
## A: Maintain existing codebase
21+
22+
## Maintain existing code-base
2423
The aim is to **keep the product in shape and usable**.
2524

2625
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
2928

3029
Main capacity shall be provided by @schettino72
3130

32-
## B: Refactor documentation
31+
32+
# Long term vision
33+
34+
## B: Rewrite documentation
3335
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**.
3436

3537
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:
3739

3840
- Introduction (basic features overview)
3941
- Quick start and tutorials
4042
- Reference documentation
4143
- 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
4745

48-
# Long term vision
49-
Assuming the A and B priorities are fulfilled, we shall look further on into future.
5046

5147
## C: Promote
5248
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:
5652
- helping selected python projects to adopt doit as internal tool
5753
- video presentations
5854
- presentation(s) at pycon(s)
59-
60-
This is long term priority and there is no budget set for it at the moment.
55+
6156

6257
## D: Launch doit task libraries
6358

6459
Grunt library has over 6000 tasks, gulp has over 3000 plug-ins.
6560

6661
`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.
6762

68-
This is long term priority and there is no budget set for it at the moment.
6963

7064
# Why to contribute?
7165

0 commit comments

Comments
 (0)
Please sign in to comment.