Skip to content

Commit 1b1a777

Browse files
committed
Merge pull request #19 from pvdissel/master
Cleaning readme for release
2 parents e00ba4e + b5fcae9 commit 1b1a777

File tree

1 file changed

+72
-24
lines changed

1 file changed

+72
-24
lines changed

README.md

Lines changed: 72 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -9,16 +9,54 @@ A Continuous Delivery (CD) tool, which we and all stakeholders of the CD pipelin
99
> flexible enough for startups
1010
> and powerful enough for the enterprise
1111
12-
Read [Why a new CD tool][1] for the reason and focus points behind this CD tool. And [DSL Design ideas][2] to give you an intro into the Domain Specific Languange (DSL) that we're working towards for defining the pipeline and its stages.
13-
14-
> Making the Impossible Possible
15-
> the Possible Simple
16-
> the Simple automated Away
12+
Find the latest release on the [releases][6] page. And follow the [installation][8] and [configuration][9] documentation to get started.
1713

1814
State of the project
1915
--------------------
20-
This project is currently in a very early state of development.
21-
[Tricode](http://www.tricode.nl) Sponsors developer-time and resources
16+
This project is currently in a very early state of development. Development happens in a LEAN way, bit by bit adding features and improving based on user experiences and feedback. Give your feedback at the [user/dev forum][3].
17+
18+
Features
19+
--------
20+
- From the ground-up, pipeline-based
21+
- Pipeline configuration in pipeline domain language (DSL)
22+
- Version controlled pipeline configuration
23+
- Support for public and private git repositories
24+
- hosted on [Github](http://github.com), triggered via [webhook][7]
25+
26+
Resources
27+
---------
28+
- Pipeline Homepage -- http://pipelinelabs.org
29+
- GitHub Organization -- http://github.pipelinelabs.org
30+
- Documentation -- http://docs.pipelinelabs.org
31+
- User/Dev Forum -- [http://forum.pipelinelabs.org][3]
32+
- Issue Tracker -- http://issues.pipelinelabs.org
33+
34+
Follow us on Twitter [@pipelinelabs](https://twitter.com/pipelinelabs)
35+
36+
If you have any ideas, comments or questions, please direct them to the [user/dev forum][3].
37+
All feedback is appreciated!
38+
39+
### Presentations
40+
- Ignite talk "Continuous Integration and Delivery tools, do we really like using them?"
41+
- [Preparation run recording][4]
42+
- [@DevOpsDays Amsterdam, June 14th 2013 recording][5]
43+
44+
Roadmap
45+
-------
46+
Some ideas on epics/topics we want to have implemented along the way, in no particular order:
47+
48+
- Configuration service that provides generic configuration to all pipelines
49+
- Also supporting a secure way for sensitive configuration data
50+
- Native packages for different OS'es, for easy installation
51+
- Also providing scripts to run services as system daemons/services
52+
- Extensive logging and monitoring functionality
53+
- Extend pipeline configuration with environment and execution information for simpler maintenance by not depending on specific server configurations, the pipeline takes care of everything in a versioned manner. For example:
54+
- Environment variables to make available to the whole pipeline, specific stages or specific commands
55+
- System applications and versions which are required to run the pipeline are installed and configured automatically
56+
- ...
57+
- Different GUI's, for the different types of users and usages
58+
- All communicating with one single API against the system
59+
- Support for different authentication and authorization schemes
2260

2361
Building Pipeline
2462
--------------
@@ -27,27 +65,37 @@ The only prerequisite is that you have JDK 7 or higher installed.
2765
After cloning the project, type `./gradlew clean build` (Windows: `gradlew clean build`). All build dependencies,
2866
including [Gradle](http://www.gradle.org) itself, will be downloaded automatically (unless already present).
2967

30-
Resources
31-
---------
32-
* Pipeline Homepage -- http://pipelinelabs.org
33-
* GitHub Organization -- http://github.pipelinelabs.org
34-
* Documentation -- http://docs.pipelinelabs.org
35-
* User/Dev Forum -- [http://forum.pipelinelabs.org][3]
36-
* Issue Tracker -- http://issues.pipelinelabs.org
37-
38-
Presentations
39-
-------------
40-
* Ignite talk "Continuous Integration and Delivery tools, do we really like using them?"
41-
* [Preparation run recording][4]
42-
* [@DevOpsDays Amsterdam, June 14th 2013 recording][5]
68+
Contributing
69+
------------
70+
Feel free to contribute! Follow these steps:
4371

44-
If you have any ideas, comments or questions, please direct them to the [user/dev forum][3].
45-
All feedback is appreciated!
72+
First time only:
73+
74+
- Fork the repo (`upstream`) to your GitHub account (`origin`).
75+
- Clone `origin` as your `local` repo
76+
77+
Every other time:
78+
79+
- Update both `origin` and `local` repos from `upstream`
80+
- Create new branch for a feature or bug fix
81+
- Commit often :)
82+
- Once when work is done, push local changes to your `origin`
83+
- Send us a pull request (PR)
84+
85+
We will pickup up from there :)
86+
87+
Special thanks to
88+
-----------------
89+
- [Andrew Oberstar](http://www.andrewoberstar.com) for being the very first code contributor and all-round providing great support and feedback
90+
- [Martin Kovachki](http://www.linkedin.com/in/martinkov) for awesome logo designs
91+
- [Tricode](http://www.tricode.nl) for sponsoring developer-time and resources
4692

4793

4894
[0]: http://github.pipelinelabs.org/blob/master/LICENSE
49-
[1]: http://docs.pipelinelabs.org/Vision:-Why-a-new-tool-for-Continuous-Delivery
50-
[2]: http://docs.pipelinelabs.org/Technical-Design:-DSL-Design-Ideas
5195
[3]: http://forum.pipelinelabs.org
5296
[4]: http://www.youtube.com/watch?v=shF_v5shzjU
5397
[5]: http://www.youtube.com/watch?v=-StobwMgRNE
98+
[6]: https://github.com/pipelinelabs/pipeline/releases
99+
[7]: https://help.github.com/articles/post-receive-hooks
100+
[8]: http://docs.pipelinelabs.org/User-Guide%3A-Set-up-with-Central-Repository
101+
[9]: http://docs.pipelinelabs.org/User-Guide%3A-Project-Pipeline-Configuration

0 commit comments

Comments
 (0)