couchdb-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From "Robert Kowalski (JIRA)" <j...@apache.org>
Subject [jira] [Commented] (COUCHDB-1787) Automate release process documentation
Date Thu, 19 Mar 2015 01:56:39 GMT

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

Robert Kowalski commented on COUCHDB-1787:
------------------------------------------

Hi Amarnath!

Sounds good! Are you participating in this years Google Summer of Code?

The Sphinx config that Dave mentioned is now located at https://github.com/apache/couchdb-documentation/blob/master/src/conf.py

If you clone the main repository https://github.com/apache/couchdb and have installed erlang
& rebar [1],  rebar will pull in the docs after running `./configure`

If I have the couchdb repo at `~/apache/couchdb/` the docs are then pulled to: `~/apache/couchdb/src/docs`

I think that are the updates related to this task as the codebase and structure evolved over
time


[1] https://github.com/rebar/rebar

> Automate release process documentation
> --------------------------------------
>
>                 Key: COUCHDB-1787
>                 URL: https://issues.apache.org/jira/browse/COUCHDB-1787
>             Project: CouchDB
>          Issue Type: Improvement
>          Components: Build System, Documentation
>            Reporter: Dave Cottlehuber
>              Labels: gsoc, gsoc2015, mentor
>
> The release process today contains a large number of manual transformation steps.
> Fixing this will make the release process significantly easier for release managers,
as well as less error-prone.
> Ideally the output formats (NEWS, CHANGES in source tree, and HTML snippets for http://couchdb.org/
website and http://blogs.apache.org/couchdb ) can be auto-generated from either the .rst files
in share/doc/src using sphinx's .versionaddded/changed tags, or potentially from commit messages
if this is appropriate.
> CouchDB documentation is generated today from restructured text using python code, and
rolled into the release documentation during `make distcheck`.



--
This message was sent by Atlassian JIRA
(v6.3.4#6332)

Mime
View raw message