## TL;DR

The Clojure documentation project (http://clojure-doc.org) continues to
make progress.
Lion's share of the work this week went into the Concurrency and
Parallelism guide:

http://clojure-doc.org/articles/language/concurrency_and_parallelism.html

which is now about 75% complete.


## CDS Progress Report

The Clojure Documentation Site (a.k.a. CDS) publishes
periodic reports (every week so far, possibly two weeks in the future)
to give the Clojure community a better idea of what CDS shapes up to
be and what it has to offer.

This is a report for the week ending October 28st, 2012.


## New Content

This week was all improvements to existing guides, no new content merged.
There is at least one new tutorial
in the works by a contributor we've heard from, though.


## Updates

By far most of the work merged this week went into the Concurrency and
Parallelism guide [1]

It now covers topics such as

 * An overview of concurrency terminology and common hazards
 * Identity/Value separation in Clojure
 * atoms
 * agents
 * refs, STM in Clojure, STM limitations
 * vars
 * delays
 * futures
 * promises
 * dereferencing
 * some commonly used `java.util.concurrent` bits
 * other approaches to concurrency on the JVM available to Clojure through
libraries

Reading that guide is highly recommended for developers of all expertise
levels with the language.


Tutorials updated this week:

 * Getting Started With Emacs for Clojure [2]

Other guides updated this week:

 * Functions [3]
 * clojure.core Overview [4]
 * Interoperability with Java [5]
 * Community [6]



## Thank You, Contributors

CDS would not be possible without the following people who make Clojure
community a better place:

 * AtKaaZ
 * Ben Poweski
 * John Gabriele
 * Lee Hinman
 * Michael S. Klishin
 * Wes Freeman


## You Can Help!

### How It Works

We have a repository on GitHub [7] that has Markdown files, toolchain setup
instructions and several articles
as well as stubs for several more articles. The stubs help contributors
pick a topic to write about and not worry too much about
article structure initially. Just pick something that you are very familiar
with or interested in and write.

When you are done, submit a pull request on GitHub and someone from the
existing contributors team will
suggest improvements or merge your work. Pretty straightforward.

In order to make it easier for potential contributors to join the project,
we will post a brief list of
guides that do not require deep expertise and can benefit from
contributions by complete beginners.

### Existing Guides

Tutorials that badly need to be written:

 * Tutorial on VimClojure [8]

Guides that have structure and good chunk of the content in place but still
have holes you
can help us plug:

 * Java interop [5]
 * Collections and Sequences [9]
 * Namespaces [10]
 * clojure.core Overview [11]

These guides are new and cover advanced topics, so we need as much
proof-reading as we can
get from the community:

 * Concurrency and Parallelism in Clojure [1]

### New Content

If you want to start working on one of those articles or have existing
content you've authored that can be ported,
please let us know on the Clojure mailing list.


## Summary

CDS is 2-3 guides from covering the language "reasonably well". There still
are holes in various guides
but mostly in the more advanced areas and

Want to help us make things better? Join us by forking and contributing to
http://github.com/clojuredocs/cds.



1. http://clojure-doc.org/articles/language/concurrency_and_parallelism.html
2. http://clojure-doc.org/articles/tutorials/emacs.html
3. http://clojure-doc.org/articles/language/functions.html
4. http://clojure-doc.org/articles/language/core_overview.html
5. http://clojure-doc.org/articles/language/interop.html
6. http://clojure-doc.org/articles/ecosystem/community.html
7. http://github.com/clojuredocs/cds
8. http://clojure-doc.org/articles/tutorials/vim.html
9. http://clojure-doc.org/articles/language/sequences.html
10. http://clojure-doc.org/articles/language/namespaces.html
11. http://clojure-doc.org/articles/language/core_overview.html


-- 
MK

http://github.com/michaelklishin
http://twitter.com/michaelklishin

-- 
You received this message because you are subscribed to the Google
Groups "Clojure" group.
To post to this group, send email to clojure@googlegroups.com
Note that posts from new members are moderated - please be patient with your 
first post.
To unsubscribe from this group, send email to
clojure+unsubscr...@googlegroups.com
For more options, visit this group at
http://groups.google.com/group/clojure?hl=en

Reply via email to