couchdb-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From Jan Lehnardt <...@apache.org>
Subject Re: Docs, second try
Date Sun, 17 Jun 2012 10:47:19 GMT

On Jun 17, 2012, at 12:12 , Jan Lehnardt wrote:

> Same repo, some news:
> 
> - updated NOTICE
> - added minimal css styling to make it not look ass
> - made make distcheck pass* (wooo!)
> - linked the per-chapter build in Futon instead of the full-page.**
> 
> As far as I can see, this is good to go into master.

Well, one more thing™: I need to hook this up to `make install`.
I'll try and do this right away.

Cheers
Jan
-- 


> 
> There's plenty of room for improvement:
> 
> - better integration into Futon
> - more approachable ToC (expandable sub-levels, e.g.)
> - better styling
> - more docs :)
> 
> Let us know if you want to help out with this!
> 
> Cheers
> Jan
> --
> 
> * Noah, could you have a look at my license.skip commit and tell me
> I'm not doing anything fishy?
> 
>  https://github.com/janl/couchdb/commit/56b664854209e00d0ff549352970abd269adb24b
> 
> ** The last commit I had to rebase to keep the history nice, that means
> the branch had to be pushed with -f. This is only relevant if you have
> checked out the branch in the past and made edits to it.
> 
> On Jun 11, 2012, at 22:05 , Jan Lehnardt wrote:
> 
>> Hey all,
>> 
>> remember that big commit I made to a new docs branch with all
>> the .jar files in it and whatnot? Well, I've cleaned it up and
>> pushed it to GitHub:
>> 
>> https://github.com/janl/couchdb/tree/docs
>> 
>> The README states all prerequisites.
>> 
>> I have ripped all the .jar files out of the repo and put them
>> in a .tgz up on:
>> 
>> http://people.apache.org/~jan/couchdb/couchdb-doc-jars.tgz
>> 
>> To build the docs go to share/docs and run
>> 
>> $ COUCHDB_DOC_JAR_DIR=/path/to/doc/jars make docs
>> 
>> This is the easiest I could think of for pushing this forward.
>> 
>> I also went through all the other resources in the share/docs
>> directory and double checked the licensing on all items and
>> couldn't find anything incompatible. I've still to update
>> the NOTICE file to make this land on ASF infrastructure, but
>> I think we are in a good position.
>> 
>> Please check out the branch and give us any feedback, I'd like
>> to finally finally get this merged soon :)
>> 
>> Cheers
>> Jan
>> -- 
>> 
> 


Mime
View raw message