incubator-couchdb-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From "Noah Slater (JIRA)" <j...@apache.org>
Subject [jira] [Commented] (COUCHDB-906) Please offer offline downloadable documentation
Date Mon, 26 Aug 2013 17:11:52 GMT

    [ https://issues.apache.org/jira/browse/COUCHDB-906?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=13750251#comment-13750251
] 

Noah Slater commented on COUCHDB-906:
-------------------------------------

Alexander, take a look at this:

https://git-wip-us.apache.org/repos/asf?p=couchdb.git;a=blob_plain;f=share/doc/templates/utilities.html;hb=HEAD

Notice the "{% if local %}" block? I added that so that you can switch the display of the
sidebar links depending on whether the docs are being served out of CouchDB, or whether they
are in RTD.

So what you could do is either modify this, or help.html, and link to a PDF version of the
docs. Change the link depending on whether 'local' is true or not.

We put a copy of the PDF on the filesystem, so you should be able to link to that from within
the locally hosted docs. If if 'local' is false, link to the RTD download.

Do you think that's a decent approach?
                
> Please offer offline downloadable documentation
> -----------------------------------------------
>
>                 Key: COUCHDB-906
>                 URL: https://issues.apache.org/jira/browse/COUCHDB-906
>             Project: CouchDB
>          Issue Type: Improvement
>          Components: Documentation
>            Reporter: Chris Wilson
>            Assignee: Alexander Shorin
>
> I mainly work on the train or in airports without Internet access, so I need offline
documentation.
> I tried to wget -r the couchdb wiki but I hit some kind of flood protection.
> Apparently MoinMoin can sync between two instances if xmlrpc is enabled. It seems to
be enabled but broken in the CouchDB wiki.
> Please could you put the wiki pages into hg or git and offer a read-only clone or a downloadable
tarball of the html versions of the pages?
> Cheers, Chris.

--
This message is automatically generated by JIRA.
If you think it was sent incorrectly, please contact your JIRA administrators
For more information on JIRA, see: http://www.atlassian.com/software/jira

Mime
View raw message