Account Options

  1. Sign in
The old Google Groups will be going away soon, but your browser is incompatible with the new version.
Google Groups Home
« Groups Home
Message from discussion ANN: a Clojure docs site, and github organization
The group you are posting to is a Usenet group. Messages posted to this group will make your email address visible to anyone on the Internet.
Your reply message has not been sent.
Your post was successful
 
From:
To:
Cc:
Followup To:
Add Cc | Add Followup-to | Edit Subject
Subject:
Validation:
For verification purposes please type the characters you see in the picture below or the numbers you hear by clicking the accessibility icon. Listen and type the numbers you hear
 
Michael Klishin  
View profile  
 More options Oct 5 2012, 4:53 pm
From: Michael Klishin <michael.s.klis...@gmail.com>
Date: Sat, 6 Oct 2012 00:52:45 +0400
Local: Fri, Oct 5 2012 4:52 pm
Subject: Re: ANN: a Clojure docs site, and github organization

2012/10/5 Andy Fingerhut <andy.finger...@gmail.com>

> Michael, are these specific plans described anywhere that we could read?
>  Or would you be able to describe them briefly?

> Curious to know what is planned there.

We are currently migrating CDS to the same toolchain clojurewerkz.org sites
use. Doing so will let us
not reinvent some wheels and it's the devil we know. This should be done
early next week.

The plan is to have a flat list of guides organized in 3 groups:

 * Tutorials
 * Language guides
 * Tools & Ecosystem guides

You can read about the difference in the README:
https://github.com/clojuredocs/cds/blob/master/README.md

There are no grand plans for the guides, just write, edit, deploy, gather
feedback, rinse and repeat.
We already have a list of guides to help people who want to contribute pick
a topic. An example of such TOC:

http://clojureelasticsearch.info/articles/guides.html

All development will happen on GitHub, with pull requests. We picked CC BY
3.0 as the license for all content:
http://creativecommons.org/licenses/by/3.0/

And then there is the API reference part. The goal is to rewrite
clojuredocs.org source parser to produce
JSON and migrate DB schema to support multiple versions. Ideally,
clojuredocs.org will be Clojure end to end.
But this will take a while and the reference part is not nearly as bad as
it is with the guides and tutorials.

CDS will not have the reference part. It will link to existing resources,
be it clojuredocs.org or something else.

I want to stress that one of the major goals (maybe the most important) of
all this is to be contributor-friendly. Contributing a spelling fix or
improving wording of something should take minutes, not weeks. Everybody
should
be able to quickly submit an improvement. Documentation guides on the
language is its face for potential
users and there is no shortage of smart people who *want* to improve the
situation with the docs, but currently
find it too inconvenient or have no opportunity to do so because of the CA
submission process.

There will be something to show next week. I hope this answers your
question.
--
MK

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


 
You must Sign in before you can post messages.
To post a message you must first join this group.
Please update your nickname on the subscription settings page before posting.
You do not have the permission required to post.