Permalink
Browse files

Updates docs with contact info, development info

  • Loading branch information...
jeffschenck committed Jul 29, 2011
1 parent 0bff7b9 commit 7977332634935f35e9064d62440ec5ef7e3bca39
Showing with 114 additions and 8 deletions.
  1. +10 −4 README.rst
  2. +71 −0 docs/development.rst
  3. +33 −4 docs/index.rst
View
@@ -6,11 +6,17 @@ powerful business reporting system.
* Define new reports quickly by writing simple Python
-* Pluggable data source and caching structure - use the built-in modules or
- write one for your own particular needs
+* Pluggable data source infrastructure — use the built-in modules or write
+ one for your own particular needs
-* Output your report data to powerful HTML/JavaScript tables, with paging,
- sorting and more
+* Powerful caching system allows for fast and easy sorting and paging
+
+Whatever business initiatives and performance indicators you want to look at,
+Blingalytics offers the tools you need to slice and dice your data. Maybe you
+want to see the number of retweets your clients get over time. Or maybe you
+simply want to track your revenue and other financial indicators. Perhaps you
+need to track how many virtual tractors your virtual farmers are purchasing.
+Blingalytics can probably help.
For the full documentation, please visit it over on `Read the Docs`_. Or if
you're feeling particularly do-it-yourself today, you can always build the
View
@@ -0,0 +1,71 @@
+Development
+===========
+
+Get the code
+------------
+
+Fork us on Github! You can find us at `https://github.com/adly/blingalytics`_.
+
+Contributing
+------------
+
+There are a few ways you can get involved with the development of
+Blingalytics.
+
+Use Blingalytics!
+^^^^^^^^^^^^^^^^^
+
+Use the code to build your business' reporting system and let us know how it
+goes. We want to know how you're using it, what problems you encountered, and
+what features you'd love to see.
+
+Report bugs
+^^^^^^^^^^^
+
+If you think you've found a bug in the code, please check our ticket tracker
+to see if anyone else has reported it yet. If not, file a bug report! Standard
+issue reporting standards apply: please succinctly describe the steps to
+reproduce and what the issue is. For now, our issues are on our
+`Github issues`_ page.
+
+Contribute patches and new features
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+If you've fixed a bug or have a feature that you think would be useful to the
+community, send us a pull request on Github.
+
+Planned features
+----------------
+
+A list, in pseudo-random order, of some features we're planning. Some of these
+are already in use at Adly and just need some polish before they're ready to
+be included. Others are brand-new features the community would benefit from.
+
+* **Front-end implementation.** Internally we use an AJAXy front-end
+ implementation built on top of YUI's DataTable. We'd like to make this
+ generic enough that it's a snap to get your own project up and running with
+ it.
+
+* **Django app.** Having a quick and easy app to plug into your Django_ project
+ would be super. This would involve a new source to interface with Django's
+ ORM, perhaps a new cache interface to Django's caching framework, and
+ probably some other niceties.
+
+* **More included sources.** While sources are pluggable enough that you can write
+ one for your own purposes, there are some common sources that we'd like to
+ support. We've considered adding sources that pull from a MapReduce, from
+ a public web API, and from various other datastores like MongoDB.
+
+* **Memcache cache implementation.** We use Redis extensively at Adly, and it
+ works incredibly well for caching and crunching report data. But I expect
+ people are more familiar with Memcache and more likely to already have it
+ set up in their infrastructure. It probably won't be as memory-efficient,
+ but it should be possible to create an implementation if there's enough of
+ a use case.
+
+* **Others?** If you have other features you think would be useful, please mention
+ them on the mailing list!
+
+.. _https://github.com/adly/blingalytics: https://github.com/adly/blingalytics
+.. _Github issues: https://github.com/adly/blingalytics/issues
+.. _Django: https://www.djangoproject.com/
View
@@ -1,27 +1,54 @@
Blingalytics
============
+About
+-----
+
Blingalytics is an open-source Python project for building a flexible,
powerful business reporting system.
* Define new reports quickly by writing simple Python
-* Pluggable data source and caching structure — use the built-in modules or
- write one for your own particular needs
+* Pluggable data source infrastructure — use the built-in modules or write
+ one for your own particular needs
+
+* Powerful caching system allows for fast and easy sorting and paging
-* Output your report data to powerful HTML/JavaScript tables, with paging,
- sorting and more
+Whatever business initiatives and performance indicators you want to look at,
+Blingalytics offers the tools you need to slice and dice your data. Maybe you
+want to see the number of retweets your clients get over time. Or maybe you
+simply want to track your revenue and other financial indicators. Perhaps you
+need to track how many virtual tractors your virtual farmers are purchasing.
+Blingalytics can probably help.
Thanks to Adly_ for fostering the development of Blingalytics as an
open-source project. Blingalytics is released under the `MIT License`_.
+Getting Help
+------------
+
+If you've already blown through the docs and haven't found the answers you're
+looking for, there are a number of other channels where you can get help.
+
+* **Mailing List**: If you need help with Blingalytics, you can post a
+ question to our `mailing list`_. The developers will do our best to reply
+ promptly.
+
+* **Twitter**: We maintain an official Twitter account, `@blingalytics`_,
+ where we'll announce official news. You can also tweet at us and see what
+ happens!
+
+* **IRC**: We'll hang out on the ``#blingalytics`` channel on Freenode, where
+ we'll try to help answer any questions.
+
Contents
--------
.. toctree::
:maxdepth: 2
install
+ development
intro
reports
sources
@@ -31,3 +58,5 @@ Contents
.. _Adly: http://adly.com/
.. _MIT License: http://www.opensource.org/licenses/mit-license
+.. _mailing list: http://groups.google.com/group/blingalytics
+.. _@blingalytics: http://twitter.com/blingalytics

0 comments on commit 7977332

Please sign in to comment.