You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@couchdb.apache.org by Jan Lehnardt <ja...@apache.org> on 2012/02/21 21:36:15 UTC
API Docs (finally)
Hi all,
I finally got my act together and prepared the CouchDB API docs that MC Brown made for Couchbase for your consideration to be added to the project.
I put it up on GitHub so you can check it out.
The repo is:
https://github.com/janl/couchdb-docs
To build all docs, you run `make everything`. I put the results on GitHub Pages.
It includes multiple HTML builds with different granularities (single page, break by section, break by chapter) as well as PDF and ePub versions:
Single Page: http://janl.github.com/couchdb-docs/couchdb-manual-1.1/couchdb-manual.html
By Chapter: http://janl.github.com/couchdb-docs/couchdb-manual-1.1/couchdb-manual.html-dir/index.html
By Section: http://janl.github.com/couchdb-docs/couchdb-manual-1.1/couchdb-manual.html-section/index.html
PDF: http://janl.github.com/couchdb-docs/couchdb-manual-1.1/couchdb-manual.pdf
ePub http://janl.github.com/couchdb-docs/couchdb-manual-1.1/couchdb-manual.epub
There's also a CouchDB 1.1. release guide that explains all the new features in depth:
Single Page: http://janl.github.com/couchdb-docs/couchdb-release-1.1/couchdb-release-1.1.html
By Chapter: http://janl.github.com/couchdb-docs/couchdb-release-1.1/couchdb-release-1.1.html-dir/index.html
By Section: http://janl.github.com/couchdb-docs/couchdb-release-1.1/couchdb-release-1.1.html-section/index.html
PDF: http://janl.github.com/couchdb-docs/couchdb-release-1.1/couchdb-release-1.1.pdf
ePub http://janl.github.com/couchdb-docs/couchdb-release-1.1/couchdb-release-1.1.epub
The README.md files outlines the build dependencies.
The license is CC 3.0 but we can adapt that to whatever is required.
There's a few rough edges, no styling should be obvious and the few screenshots are using our old Single Server branded Futon, but I don't consider these things to block adoption.
Let me know what you think. I hope you like it! :)
(weeee finally!)
Cheers
Jan
--
Re: API Docs (finally)
Posted by Jason Smith <jh...@iriscouch.com>.
On Wed, Feb 22, 2012 at 8:32 AM, Paul Davis <pa...@gmail.com> wrote:
> On Wed, Feb 22, 2012 at 1:34 AM, Randall Leeds <ra...@gmail.com> wrote:
>> I think it works out fine so long as git commits don't hit upstream until
>> after someone has 'git svn rebase'd them locally and then 'svn dcommit'd
>> them. Otherwise you need to force push the git copy. In other words git
>> commits that have not been pushed to svn are provisional and will have
>> their hashed changed after they hit svn. Nothing prevents us from
>> collaborating in git as long as we push first to svn before using the
>> git-svn copy to push to the canonical git repo.
>
> This is some sort of elaborate troll to make my head explode before bed, right?
Perhaps this isn't a fruitful line of discussion. It sounds like you
have an idea of a pretty workable solution similar to Gunicorn; and
anyway this thread focuses on the API docs.
--
Iris Couch
Re: API Docs (finally)
Posted by Paul Davis <pa...@gmail.com>.
On Wed, Feb 22, 2012 at 1:34 AM, Randall Leeds <ra...@gmail.com> wrote:
> I think it works out fine so long as git commits don't hit upstream until
> after someone has 'git svn rebase'd them locally and then 'svn dcommit'd
> them. Otherwise you need to force push the git copy. In other words git
> commits that have not been pushed to svn are provisional and will have
> their hashed changed after they hit svn. Nothing prevents us from
> collaborating in git as long as we push first to svn before using the
> git-svn copy to push to the canonical git repo.
This is some sort of elaborate troll to make my head explode before bed, right?
In case we're not on the same page, I was considering how to add docs
and website sources to the Git repo hosted at git-wip-us.a.o. What
you're suggesting sounds like a couple steps backwards for the whole
writable Git repo thing.
> On Feb 21, 2012 9:28 PM, "Paul Davis" <pa...@gmail.com> wrote:
>
>> On Tue, Feb 21, 2012 at 7:07 PM, Jason Smith <jh...@iriscouch.com> wrote:
>> > Jan, easy question:
>> >
>> > CouchDB is now in Git, and now there are two additional projects
>> > people are talking about: the web site and now the documentation.
>> >
>> > I wonder if the same repo could host all three projects, with
>> > dissimilar, independent history trees. (I know the web site has svn
>> > requirements but most would agree that git-svn is quite excellent
>> > dealing with this.)
>> >
>>
>> Someone feel free to correct me if I'm wrong, but I think this would
>> require that our Git repo mirror some form of an SVN url. Plus our
>> history has been disconnected so we'd have to do some fancy dancing to
>> get things back in sync.
>>
>> So basically, no. But I can't think of a reason that we can't host
>> both in the Git repo and then write a script that forcibly updates
>> some random SVN url. Me and Benoit have a very similar setup for
>> handling all the documentation for Gunicorn (though its based on
>> GitHub's Pages thing in a branch (but the basic idea is the same).
>>
>> > On Wed, Feb 22, 2012 at 3:36 AM, Jan Lehnardt <ja...@apache.org> wrote:
>> >> Hi all,
>> >>
>> >> I finally got my act together and prepared the CouchDB API docs that MC
>> Brown made for Couchbase for your consideration to be added to the project.
>> >>
>> >> I put it up on GitHub so you can check it out.
>> >>
>> >> The repo is:
>> >>
>> >> https://github.com/janl/couchdb-docs
>> >>
>> >> To build all docs, you run `make everything`. I put the results on
>> GitHub Pages.
>> >>
>> >> It includes multiple HTML builds with different granularities (single
>> page, break by section, break by chapter) as well as PDF and ePub versions:
>> >>
>> >> Single Page:
>> http://janl.github.com/couchdb-docs/couchdb-manual-1.1/couchdb-manual.html
>> >> By Chapter:
>> http://janl.github.com/couchdb-docs/couchdb-manual-1.1/couchdb-manual.html-dir/index.html
>> >> By Section:
>> http://janl.github.com/couchdb-docs/couchdb-manual-1.1/couchdb-manual.html-section/index.html
>> >> PDF:
>> http://janl.github.com/couchdb-docs/couchdb-manual-1.1/couchdb-manual.pdf
>> >> ePub
>> http://janl.github.com/couchdb-docs/couchdb-manual-1.1/couchdb-manual.epub
>> >>
>> >> There's also a CouchDB 1.1. release guide that explains all the new
>> features in depth:
>> >>
>> >> Single Page:
>> http://janl.github.com/couchdb-docs/couchdb-release-1.1/couchdb-release-1.1.html
>> >> By Chapter:
>> http://janl.github.com/couchdb-docs/couchdb-release-1.1/couchdb-release-1.1.html-dir/index.html
>> >> By Section:
>> http://janl.github.com/couchdb-docs/couchdb-release-1.1/couchdb-release-1.1.html-section/index.html
>> >> PDF:
>> http://janl.github.com/couchdb-docs/couchdb-release-1.1/couchdb-release-1.1.pdf
>> >> ePub
>> http://janl.github.com/couchdb-docs/couchdb-release-1.1/couchdb-release-1.1.epub
>> >>
>> >> The README.md files outlines the build dependencies.
>> >>
>> >> The license is CC 3.0 but we can adapt that to whatever is required.
>> >>
>> >> There's a few rough edges, no styling should be obvious and the few
>> screenshots are using our old Single Server branded Futon, but I don't
>> consider these things to block adoption.
>> >>
>> >> Let me know what you think. I hope you like it! :)
>> >>
>> >> (weeee finally!)
>> >>
>> >> Cheers
>> >> Jan
>> >> --
>> >>
>> >
>> >
>> >
>> > --
>> > Iris Couch
>>
Re: API Docs (finally)
Posted by Randall Leeds <ra...@gmail.com>.
I think it works out fine so long as git commits don't hit upstream until
after someone has 'git svn rebase'd them locally and then 'svn dcommit'd
them. Otherwise you need to force push the git copy. In other words git
commits that have not been pushed to svn are provisional and will have
their hashed changed after they hit svn. Nothing prevents us from
collaborating in git as long as we push first to svn before using the
git-svn copy to push to the canonical git repo.
On Feb 21, 2012 9:28 PM, "Paul Davis" <pa...@gmail.com> wrote:
> On Tue, Feb 21, 2012 at 7:07 PM, Jason Smith <jh...@iriscouch.com> wrote:
> > Jan, easy question:
> >
> > CouchDB is now in Git, and now there are two additional projects
> > people are talking about: the web site and now the documentation.
> >
> > I wonder if the same repo could host all three projects, with
> > dissimilar, independent history trees. (I know the web site has svn
> > requirements but most would agree that git-svn is quite excellent
> > dealing with this.)
> >
>
> Someone feel free to correct me if I'm wrong, but I think this would
> require that our Git repo mirror some form of an SVN url. Plus our
> history has been disconnected so we'd have to do some fancy dancing to
> get things back in sync.
>
> So basically, no. But I can't think of a reason that we can't host
> both in the Git repo and then write a script that forcibly updates
> some random SVN url. Me and Benoit have a very similar setup for
> handling all the documentation for Gunicorn (though its based on
> GitHub's Pages thing in a branch (but the basic idea is the same).
>
> > On Wed, Feb 22, 2012 at 3:36 AM, Jan Lehnardt <ja...@apache.org> wrote:
> >> Hi all,
> >>
> >> I finally got my act together and prepared the CouchDB API docs that MC
> Brown made for Couchbase for your consideration to be added to the project.
> >>
> >> I put it up on GitHub so you can check it out.
> >>
> >> The repo is:
> >>
> >> https://github.com/janl/couchdb-docs
> >>
> >> To build all docs, you run `make everything`. I put the results on
> GitHub Pages.
> >>
> >> It includes multiple HTML builds with different granularities (single
> page, break by section, break by chapter) as well as PDF and ePub versions:
> >>
> >> Single Page:
> http://janl.github.com/couchdb-docs/couchdb-manual-1.1/couchdb-manual.html
> >> By Chapter:
> http://janl.github.com/couchdb-docs/couchdb-manual-1.1/couchdb-manual.html-dir/index.html
> >> By Section:
> http://janl.github.com/couchdb-docs/couchdb-manual-1.1/couchdb-manual.html-section/index.html
> >> PDF:
> http://janl.github.com/couchdb-docs/couchdb-manual-1.1/couchdb-manual.pdf
> >> ePub
> http://janl.github.com/couchdb-docs/couchdb-manual-1.1/couchdb-manual.epub
> >>
> >> There's also a CouchDB 1.1. release guide that explains all the new
> features in depth:
> >>
> >> Single Page:
> http://janl.github.com/couchdb-docs/couchdb-release-1.1/couchdb-release-1.1.html
> >> By Chapter:
> http://janl.github.com/couchdb-docs/couchdb-release-1.1/couchdb-release-1.1.html-dir/index.html
> >> By Section:
> http://janl.github.com/couchdb-docs/couchdb-release-1.1/couchdb-release-1.1.html-section/index.html
> >> PDF:
> http://janl.github.com/couchdb-docs/couchdb-release-1.1/couchdb-release-1.1.pdf
> >> ePub
> http://janl.github.com/couchdb-docs/couchdb-release-1.1/couchdb-release-1.1.epub
> >>
> >> The README.md files outlines the build dependencies.
> >>
> >> The license is CC 3.0 but we can adapt that to whatever is required.
> >>
> >> There's a few rough edges, no styling should be obvious and the few
> screenshots are using our old Single Server branded Futon, but I don't
> consider these things to block adoption.
> >>
> >> Let me know what you think. I hope you like it! :)
> >>
> >> (weeee finally!)
> >>
> >> Cheers
> >> Jan
> >> --
> >>
> >
> >
> >
> > --
> > Iris Couch
>
Re: API Docs (finally)
Posted by Paul Davis <pa...@gmail.com>.
On Tue, Feb 21, 2012 at 7:07 PM, Jason Smith <jh...@iriscouch.com> wrote:
> Jan, easy question:
>
> CouchDB is now in Git, and now there are two additional projects
> people are talking about: the web site and now the documentation.
>
> I wonder if the same repo could host all three projects, with
> dissimilar, independent history trees. (I know the web site has svn
> requirements but most would agree that git-svn is quite excellent
> dealing with this.)
>
Someone feel free to correct me if I'm wrong, but I think this would
require that our Git repo mirror some form of an SVN url. Plus our
history has been disconnected so we'd have to do some fancy dancing to
get things back in sync.
So basically, no. But I can't think of a reason that we can't host
both in the Git repo and then write a script that forcibly updates
some random SVN url. Me and Benoit have a very similar setup for
handling all the documentation for Gunicorn (though its based on
GitHub's Pages thing in a branch (but the basic idea is the same).
> On Wed, Feb 22, 2012 at 3:36 AM, Jan Lehnardt <ja...@apache.org> wrote:
>> Hi all,
>>
>> I finally got my act together and prepared the CouchDB API docs that MC Brown made for Couchbase for your consideration to be added to the project.
>>
>> I put it up on GitHub so you can check it out.
>>
>> The repo is:
>>
>> https://github.com/janl/couchdb-docs
>>
>> To build all docs, you run `make everything`. I put the results on GitHub Pages.
>>
>> It includes multiple HTML builds with different granularities (single page, break by section, break by chapter) as well as PDF and ePub versions:
>>
>> Single Page: http://janl.github.com/couchdb-docs/couchdb-manual-1.1/couchdb-manual.html
>> By Chapter: http://janl.github.com/couchdb-docs/couchdb-manual-1.1/couchdb-manual.html-dir/index.html
>> By Section: http://janl.github.com/couchdb-docs/couchdb-manual-1.1/couchdb-manual.html-section/index.html
>> PDF: http://janl.github.com/couchdb-docs/couchdb-manual-1.1/couchdb-manual.pdf
>> ePub http://janl.github.com/couchdb-docs/couchdb-manual-1.1/couchdb-manual.epub
>>
>> There's also a CouchDB 1.1. release guide that explains all the new features in depth:
>>
>> Single Page: http://janl.github.com/couchdb-docs/couchdb-release-1.1/couchdb-release-1.1.html
>> By Chapter: http://janl.github.com/couchdb-docs/couchdb-release-1.1/couchdb-release-1.1.html-dir/index.html
>> By Section: http://janl.github.com/couchdb-docs/couchdb-release-1.1/couchdb-release-1.1.html-section/index.html
>> PDF: http://janl.github.com/couchdb-docs/couchdb-release-1.1/couchdb-release-1.1.pdf
>> ePub http://janl.github.com/couchdb-docs/couchdb-release-1.1/couchdb-release-1.1.epub
>>
>> The README.md files outlines the build dependencies.
>>
>> The license is CC 3.0 but we can adapt that to whatever is required.
>>
>> There's a few rough edges, no styling should be obvious and the few screenshots are using our old Single Server branded Futon, but I don't consider these things to block adoption.
>>
>> Let me know what you think. I hope you like it! :)
>>
>> (weeee finally!)
>>
>> Cheers
>> Jan
>> --
>>
>
>
>
> --
> Iris Couch
Re: API Docs (finally)
Posted by Jason Smith <jh...@iriscouch.com>.
Jan, easy question:
CouchDB is now in Git, and now there are two additional projects
people are talking about: the web site and now the documentation.
I wonder if the same repo could host all three projects, with
dissimilar, independent history trees. (I know the web site has svn
requirements but most would agree that git-svn is quite excellent
dealing with this.)
On Wed, Feb 22, 2012 at 3:36 AM, Jan Lehnardt <ja...@apache.org> wrote:
> Hi all,
>
> I finally got my act together and prepared the CouchDB API docs that MC Brown made for Couchbase for your consideration to be added to the project.
>
> I put it up on GitHub so you can check it out.
>
> The repo is:
>
> https://github.com/janl/couchdb-docs
>
> To build all docs, you run `make everything`. I put the results on GitHub Pages.
>
> It includes multiple HTML builds with different granularities (single page, break by section, break by chapter) as well as PDF and ePub versions:
>
> Single Page: http://janl.github.com/couchdb-docs/couchdb-manual-1.1/couchdb-manual.html
> By Chapter: http://janl.github.com/couchdb-docs/couchdb-manual-1.1/couchdb-manual.html-dir/index.html
> By Section: http://janl.github.com/couchdb-docs/couchdb-manual-1.1/couchdb-manual.html-section/index.html
> PDF: http://janl.github.com/couchdb-docs/couchdb-manual-1.1/couchdb-manual.pdf
> ePub http://janl.github.com/couchdb-docs/couchdb-manual-1.1/couchdb-manual.epub
>
> There's also a CouchDB 1.1. release guide that explains all the new features in depth:
>
> Single Page: http://janl.github.com/couchdb-docs/couchdb-release-1.1/couchdb-release-1.1.html
> By Chapter: http://janl.github.com/couchdb-docs/couchdb-release-1.1/couchdb-release-1.1.html-dir/index.html
> By Section: http://janl.github.com/couchdb-docs/couchdb-release-1.1/couchdb-release-1.1.html-section/index.html
> PDF: http://janl.github.com/couchdb-docs/couchdb-release-1.1/couchdb-release-1.1.pdf
> ePub http://janl.github.com/couchdb-docs/couchdb-release-1.1/couchdb-release-1.1.epub
>
> The README.md files outlines the build dependencies.
>
> The license is CC 3.0 but we can adapt that to whatever is required.
>
> There's a few rough edges, no styling should be obvious and the few screenshots are using our old Single Server branded Futon, but I don't consider these things to block adoption.
>
> Let me know what you think. I hope you like it! :)
>
> (weeee finally!)
>
> Cheers
> Jan
> --
>
--
Iris Couch
Re: API Docs (finally)
Posted by Adam Kocoloski <ko...@apache.org>.
Jan, this is fantastic. Thanks for seeing it through!
Adam
On Feb 21, 2012, at 3:36 PM, Jan Lehnardt wrote:
> Hi all,
>
> I finally got my act together and prepared the CouchDB API docs that MC Brown made for Couchbase for your consideration to be added to the project.
>
> I put it up on GitHub so you can check it out.
>
> The repo is:
>
> https://github.com/janl/couchdb-docs
>
> To build all docs, you run `make everything`. I put the results on GitHub Pages.
>
> It includes multiple HTML builds with different granularities (single page, break by section, break by chapter) as well as PDF and ePub versions:
>
> Single Page: http://janl.github.com/couchdb-docs/couchdb-manual-1.1/couchdb-manual.html
> By Chapter: http://janl.github.com/couchdb-docs/couchdb-manual-1.1/couchdb-manual.html-dir/index.html
> By Section: http://janl.github.com/couchdb-docs/couchdb-manual-1.1/couchdb-manual.html-section/index.html
> PDF: http://janl.github.com/couchdb-docs/couchdb-manual-1.1/couchdb-manual.pdf
> ePub http://janl.github.com/couchdb-docs/couchdb-manual-1.1/couchdb-manual.epub
>
> There's also a CouchDB 1.1. release guide that explains all the new features in depth:
>
> Single Page: http://janl.github.com/couchdb-docs/couchdb-release-1.1/couchdb-release-1.1.html
> By Chapter: http://janl.github.com/couchdb-docs/couchdb-release-1.1/couchdb-release-1.1.html-dir/index.html
> By Section: http://janl.github.com/couchdb-docs/couchdb-release-1.1/couchdb-release-1.1.html-section/index.html
> PDF: http://janl.github.com/couchdb-docs/couchdb-release-1.1/couchdb-release-1.1.pdf
> ePub http://janl.github.com/couchdb-docs/couchdb-release-1.1/couchdb-release-1.1.epub
>
> The README.md files outlines the build dependencies.
>
> The license is CC 3.0 but we can adapt that to whatever is required.
>
> There's a few rough edges, no styling should be obvious and the few screenshots are using our old Single Server branded Futon, but I don't consider these things to block adoption.
>
> Let me know what you think. I hope you like it! :)
>
> (weeee finally!)
>
> Cheers
> Jan
> --
>
Re: API Docs (finally)
Posted by MC Brown <mc...@couchbase.com>.
>> [New subthread]
>>
>> Jan, I see the Creative Commons license, but which one is it? Usually
>> it is "-Attribution" plus zero or more of:
>>
>> * -NonCommercial
>> * -ShareAlike
>>
>> I am guessing -Atribution only. Correct? Thanks.
>
> Yeah, I think CC 3.0-A was meant. MC correct me if I am wrong.
Correct :)
> Since part of the docs is code that builds the docs, that code should be under Apache License 2.0 rather than CC. But whatever is required to get this integrated into Apache CouchDB we can make work.
--
MC Brown, VP of Documentation
mc@couchbase.com
Skype: mcmcslp Mobile: +44 7411 295711 (GMT)
Re: API Docs (finally)
Posted by Jan Lehnardt <ja...@apache.org>.
On Feb 22, 2012, at 08:40 , Jason Smith wrote:
> [New subthread]
>
> Jan, I see the Creative Commons license, but which one is it? Usually
> it is "-Attribution" plus zero or more of:
>
> * -NonCommercial
> * -ShareAlike
>
> I am guessing -Atribution only. Correct? Thanks.
Yeah, I think CC 3.0-A was meant. MC correct me if I am wrong.
Since part of the docs is code that builds the docs, that code should be under Apache License 2.0 rather than CC. But whatever is required to get this integrated into Apache CouchDB we can make work.
Cheers
Jan
--
>
> On Tue, Feb 21, 2012 at 8:36 PM, Jan Lehnardt <ja...@apache.org> wrote:
>> Hi all,
>>
>> I finally got my act together and prepared the CouchDB API docs that MC Brown made for Couchbase for your consideration to be added to the project.
>>
>> I put it up on GitHub so you can check it out.
>>
>> The repo is:
>>
>> https://github.com/janl/couchdb-docs
>>
>> To build all docs, you run `make everything`. I put the results on GitHub Pages.
>>
>> It includes multiple HTML builds with different granularities (single page, break by section, break by chapter) as well as PDF and ePub versions:
>>
>> Single Page: http://janl.github.com/couchdb-docs/couchdb-manual-1.1/couchdb-manual.html
>> By Chapter: http://janl.github.com/couchdb-docs/couchdb-manual-1.1/couchdb-manual.html-dir/index.html
>> By Section: http://janl.github.com/couchdb-docs/couchdb-manual-1.1/couchdb-manual.html-section/index.html
>> PDF: http://janl.github.com/couchdb-docs/couchdb-manual-1.1/couchdb-manual.pdf
>> ePub http://janl.github.com/couchdb-docs/couchdb-manual-1.1/couchdb-manual.epub
>>
>> There's also a CouchDB 1.1. release guide that explains all the new features in depth:
>>
>> Single Page: http://janl.github.com/couchdb-docs/couchdb-release-1.1/couchdb-release-1.1.html
>> By Chapter: http://janl.github.com/couchdb-docs/couchdb-release-1.1/couchdb-release-1.1.html-dir/index.html
>> By Section: http://janl.github.com/couchdb-docs/couchdb-release-1.1/couchdb-release-1.1.html-section/index.html
>> PDF: http://janl.github.com/couchdb-docs/couchdb-release-1.1/couchdb-release-1.1.pdf
>> ePub http://janl.github.com/couchdb-docs/couchdb-release-1.1/couchdb-release-1.1.epub
>>
>> The README.md files outlines the build dependencies.
>>
>> The license is CC 3.0 but we can adapt that to whatever is required.
>>
>> There's a few rough edges, no styling should be obvious and the few screenshots are using our old Single Server branded Futon, but I don't consider these things to block adoption.
>>
>> Let me know what you think. I hope you like it! :)
>>
>> (weeee finally!)
>>
>> Cheers
>> Jan
>> --
>>
>
>
>
> --
> Iris Couch
Re: API Docs (finally)
Posted by Jason Smith <jh...@iriscouch.com>.
[New subthread]
Jan, I see the Creative Commons license, but which one is it? Usually
it is "-Attribution" plus zero or more of:
* -NonCommercial
* -ShareAlike
I am guessing -Atribution only. Correct? Thanks.
On Tue, Feb 21, 2012 at 8:36 PM, Jan Lehnardt <ja...@apache.org> wrote:
> Hi all,
>
> I finally got my act together and prepared the CouchDB API docs that MC Brown made for Couchbase for your consideration to be added to the project.
>
> I put it up on GitHub so you can check it out.
>
> The repo is:
>
> https://github.com/janl/couchdb-docs
>
> To build all docs, you run `make everything`. I put the results on GitHub Pages.
>
> It includes multiple HTML builds with different granularities (single page, break by section, break by chapter) as well as PDF and ePub versions:
>
> Single Page: http://janl.github.com/couchdb-docs/couchdb-manual-1.1/couchdb-manual.html
> By Chapter: http://janl.github.com/couchdb-docs/couchdb-manual-1.1/couchdb-manual.html-dir/index.html
> By Section: http://janl.github.com/couchdb-docs/couchdb-manual-1.1/couchdb-manual.html-section/index.html
> PDF: http://janl.github.com/couchdb-docs/couchdb-manual-1.1/couchdb-manual.pdf
> ePub http://janl.github.com/couchdb-docs/couchdb-manual-1.1/couchdb-manual.epub
>
> There's also a CouchDB 1.1. release guide that explains all the new features in depth:
>
> Single Page: http://janl.github.com/couchdb-docs/couchdb-release-1.1/couchdb-release-1.1.html
> By Chapter: http://janl.github.com/couchdb-docs/couchdb-release-1.1/couchdb-release-1.1.html-dir/index.html
> By Section: http://janl.github.com/couchdb-docs/couchdb-release-1.1/couchdb-release-1.1.html-section/index.html
> PDF: http://janl.github.com/couchdb-docs/couchdb-release-1.1/couchdb-release-1.1.pdf
> ePub http://janl.github.com/couchdb-docs/couchdb-release-1.1/couchdb-release-1.1.epub
>
> The README.md files outlines the build dependencies.
>
> The license is CC 3.0 but we can adapt that to whatever is required.
>
> There's a few rough edges, no styling should be obvious and the few screenshots are using our old Single Server branded Futon, but I don't consider these things to block adoption.
>
> Let me know what you think. I hope you like it! :)
>
> (weeee finally!)
>
> Cheers
> Jan
> --
>
--
Iris Couch
Re: API Docs (finally)
Posted by MC Brown <mc...@couchbase.com>.
>> Two more things. (I want to just send a GH issue but I only just saw
>> your comment.)
>>
>> I am getting a failure for `make publish`. It is as if there is no
>> such target. However `make everything` seems to produce everything I
>> could want: html files, PDFs, epubs. So is that a relic of an internal
>> procedure or something?
>
> MC? :) I' think I've only ever run make everything, or specific
> format targets.
Yeah, the 'publish' target was a final step that used to rsync stuff up somewhere, it can be safely ignored.
>
>> Next, the screenshots of Futon are branded Couchbase. I am totally
>> biased here but if a third-party could plug in their own screenshots,
>> so the builds were branded correctly, that would be awesome. Something
>> like the new "Welcome" JSON that CouchDB master sends. People will be
>> doing this anyway. Might as well parameterize it.
>
> Sure, send patches :)
>
>
>> The PDF also still vaguely resembles the Couchbase color scheme.
>
> I mentioned that :)
Easy to fix. In DocKit/xsl.d/fo.xsl you'll see the styles for the various parts of the PDF.
MC
--
MC Brown, VP of Documentation
mc@couchbase.com
Skype: mcmcslp Mobile: +44 7411 295711 (GMT)
Re: API Docs (finally)
Posted by Jan Lehnardt <ja...@apache.org>.
On Feb 22, 2012, at 09:01 , Jason Smith wrote:
> Two more things. (I want to just send a GH issue but I only just saw
> your comment.)
>
> I am getting a failure for `make publish`. It is as if there is no
> such target. However `make everything` seems to produce everything I
> could want: html files, PDFs, epubs. So is that a relic of an internal
> procedure or something?
MC? :) I' think I've only ever run make everything, or specific
format targets.
> Next, the screenshots of Futon are branded Couchbase. I am totally
> biased here but if a third-party could plug in their own screenshots,
> so the builds were branded correctly, that would be awesome. Something
> like the new "Welcome" JSON that CouchDB master sends. People will be
> doing this anyway. Might as well parameterize it.
Sure, send patches :)
> The PDF also still vaguely resembles the Couchbase color scheme.
I mentioned that :)
>> There's a few rough edges, no styling should be obvious and the few screenshots are using our old Single Server branded Futon, but I don't consider these things to block adoption.
Cheers
Jan
--
Re: API Docs (finally)
Posted by Jason Smith <jh...@iriscouch.com>.
Two more things. (I want to just send a GH issue but I only just saw
your comment.)
I am getting a failure for `make publish`. It is as if there is no
such target. However `make everything` seems to produce everything I
could want: html files, PDFs, epubs. So is that a relic of an internal
procedure or something?
Next, the screenshots of Futon are branded Couchbase. I am totally
biased here but if a third-party could plug in their own screenshots,
so the builds were branded correctly, that would be awesome. Something
like the new "Welcome" JSON that CouchDB master sends. People will be
doing this anyway. Might as well parameterize it.
The PDF also still vaguely resembles the Couchbase color scheme.
On Tue, Feb 21, 2012 at 8:36 PM, Jan Lehnardt <ja...@apache.org> wrote:
> Hi all,
>
> I finally got my act together and prepared the CouchDB API docs that MC Brown made for Couchbase for your consideration to be added to the project.
>
> I put it up on GitHub so you can check it out.
>
> The repo is:
>
> https://github.com/janl/couchdb-docs
>
> To build all docs, you run `make everything`. I put the results on GitHub Pages.
>
> It includes multiple HTML builds with different granularities (single page, break by section, break by chapter) as well as PDF and ePub versions:
>
> Single Page: http://janl.github.com/couchdb-docs/couchdb-manual-1.1/couchdb-manual.html
> By Chapter: http://janl.github.com/couchdb-docs/couchdb-manual-1.1/couchdb-manual.html-dir/index.html
> By Section: http://janl.github.com/couchdb-docs/couchdb-manual-1.1/couchdb-manual.html-section/index.html
> PDF: http://janl.github.com/couchdb-docs/couchdb-manual-1.1/couchdb-manual.pdf
> ePub http://janl.github.com/couchdb-docs/couchdb-manual-1.1/couchdb-manual.epub
>
> There's also a CouchDB 1.1. release guide that explains all the new features in depth:
>
> Single Page: http://janl.github.com/couchdb-docs/couchdb-release-1.1/couchdb-release-1.1.html
> By Chapter: http://janl.github.com/couchdb-docs/couchdb-release-1.1/couchdb-release-1.1.html-dir/index.html
> By Section: http://janl.github.com/couchdb-docs/couchdb-release-1.1/couchdb-release-1.1.html-section/index.html
> PDF: http://janl.github.com/couchdb-docs/couchdb-release-1.1/couchdb-release-1.1.pdf
> ePub http://janl.github.com/couchdb-docs/couchdb-release-1.1/couchdb-release-1.1.epub
>
> The README.md files outlines the build dependencies.
>
> The license is CC 3.0 but we can adapt that to whatever is required.
>
> There's a few rough edges, no styling should be obvious and the few screenshots are using our old Single Server branded Futon, but I don't consider these things to block adoption.
>
> Let me know what you think. I hope you like it! :)
>
> (weeee finally!)
>
> Cheers
> Jan
> --
>
--
Iris Couch
Re: API Docs (finally)
Posted by Robert Newson <rn...@apache.org>.
excellent!
On 21 February 2012 20:36, Jan Lehnardt <ja...@apache.org> wrote:
> Hi all,
>
> I finally got my act together and prepared the CouchDB API docs that MC Brown made for Couchbase for your consideration to be added to the project.
>
> I put it up on GitHub so you can check it out.
>
> The repo is:
>
> https://github.com/janl/couchdb-docs
>
> To build all docs, you run `make everything`. I put the results on GitHub Pages.
>
> It includes multiple HTML builds with different granularities (single page, break by section, break by chapter) as well as PDF and ePub versions:
>
> Single Page: http://janl.github.com/couchdb-docs/couchdb-manual-1.1/couchdb-manual.html
> By Chapter: http://janl.github.com/couchdb-docs/couchdb-manual-1.1/couchdb-manual.html-dir/index.html
> By Section: http://janl.github.com/couchdb-docs/couchdb-manual-1.1/couchdb-manual.html-section/index.html
> PDF: http://janl.github.com/couchdb-docs/couchdb-manual-1.1/couchdb-manual.pdf
> ePub http://janl.github.com/couchdb-docs/couchdb-manual-1.1/couchdb-manual.epub
>
> There's also a CouchDB 1.1. release guide that explains all the new features in depth:
>
> Single Page: http://janl.github.com/couchdb-docs/couchdb-release-1.1/couchdb-release-1.1.html
> By Chapter: http://janl.github.com/couchdb-docs/couchdb-release-1.1/couchdb-release-1.1.html-dir/index.html
> By Section: http://janl.github.com/couchdb-docs/couchdb-release-1.1/couchdb-release-1.1.html-section/index.html
> PDF: http://janl.github.com/couchdb-docs/couchdb-release-1.1/couchdb-release-1.1.pdf
> ePub http://janl.github.com/couchdb-docs/couchdb-release-1.1/couchdb-release-1.1.epub
>
> The README.md files outlines the build dependencies.
>
> The license is CC 3.0 but we can adapt that to whatever is required.
>
> There's a few rough edges, no styling should be obvious and the few screenshots are using our old Single Server branded Futon, but I don't consider these things to block adoption.
>
> Let me know what you think. I hope you like it! :)
>
> (weeee finally!)
>
> Cheers
> Jan
> --
>