Contributing to BlueBream
You can contribute to BlueBream project in many ways. We are updating this wiki frequently with latest information about the project. This page will document various methods to contribute to BlueBream project. Please read this page to understand opportunities where you can contribute.
Spreading the word
To reach many people, you can spread the word of BlueBream using various platforms like blog and social networking sites. Writing blog entries regularly will help to spread the word. You can present BlueBream in your local Python meetup. You can also give talks at various conferences.
Documentation
We are looking for contributors to write documentation. More up-to-date information about documentation TODO item is available in the documentation issue tracker
Bug fixing
We are collecting all the bugs and issues at launchpad . We need more volunteers to fix bugs. You can also join the bug days organized by ZTK project
Participating in mailing list and IRC
You can help our community to grow by answering questions in mailing list and IRC channel. This will help new users of BlueBream, you will also learn many things along with this.
Coding
To get commit access, please consult: becoming a contributor document. For any queries, please contact us in mailing list or IRC channel, we can refer you to get commit access (A referrence committer is required to fill the contributor agreement form).
More details about source code: Source Code
Updating Documentation Website
The project documentation is located at: http://bluebream.zope.org Here is the instruction for updating documentation website:
svn co svn+ssh://USERNAME@svn.zope.org/repos/main/bluebream/website bluebream_website cd bluebream_website python2.6 bootstrap.py ./bin/buildout #Make modification and commit changes to svn ./bin/makesite.sh svn ci
If you don't have commit access use this URL to checkout: svn://svn.zope.org/repos/main/bluebream/website The site will be generated inside htdocs/ directory, you can open htdocs/index.html in browser. There is a README.txt file with more details about directory structure.
Now we are focusing of 1.0 documentation, the content is available inside docs/v1.0 directory.
The site is built using Sphinx, so you should be familiar with reStructuredText and Sphinx itself.