couchdb-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From Dave Cottlehuber <...@jsonified.com>
Subject Re: [jira] [Created] (COUCHDB-1658) Redirect to online docs if local aren't available
Date Tue, 29 Jan 2013 20:43:32 GMT
On 29 January 2013 21:19, Alexander Shorin (JIRA) <jira@apache.org> wrote:
> Alexander Shorin created COUCHDB-1658:
> -----------------------------------------
>
>              Summary: Redirect to online docs if local aren't available
>                  Key: COUCHDB-1658
>                  URL: https://issues.apache.org/jira/browse/COUCHDB-1658
>              Project: CouchDB
>           Issue Type: Improvement
>           Components: Documentation
>             Reporter: Alexander Shorin
>
>
> Probably, it's better to redirect user to online docs (e.g. https://couchdb.readthedocs.org/en/{version}/
) instead of showing "Not found." message if CouchDB was built without local docs support.
Since {version} might not be equal to the branch name, may be take major and minor numbers
with 'x' joined by dot '.' or set it as 'latest' if 'git' substring was found in version.

It's worth noting that this will not happen with the release tgz, nor
with anything bundled with a distribution presumably as they will have
the docs baked in. So this relates to people using git checkouts only.

Anyway a patch would be great Alex if you feel like it :D

A+
Dave

Mime
View raw message