You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@couchdb.apache.org by "Dave Cottlehuber (JIRA)" <ji...@apache.org> on 2012/09/26 22:59:07 UTC
[jira] [Created] (COUCHDB-1536) Integrate Docs into Release Process
Dave Cottlehuber created COUCHDB-1536:
-----------------------------------------
Summary: Integrate Docs into Release Process
Key: COUCHDB-1536
URL: https://issues.apache.org/jira/browse/COUCHDB-1536
Project: CouchDB
Issue Type: Improvement
Components: Documentation
Affects Versions: 1.3
Reporter: Dave Cottlehuber
Fix For: 1.3
List of outstanding tasks for integrating documentation into CouchDB build chain:
- create DNS CNAME docs -> couchdb.readthedocs.org
- add that to quicklinks on main site
- extend makefile to: check for sphinx-build in PATH, & do the right thing in make dist
- check if that works in VPATH build
- update wiki /Documentation as required
--
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
[jira] [Commented] (COUCHDB-1536) Integrate Docs into Release
Process
Posted by "Noah Slater (JIRA)" <ji...@apache.org>.
[ https://issues.apache.org/jira/browse/COUCHDB-1536?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=13490070#comment-13490070 ]
Noah Slater commented on COUCHDB-1536:
--------------------------------------
The script is behaving as expected, from my POV. pdflatex is a dependancy of sphynx-build. And our build is failing because it has detected it is not present, and the PDF needs to be rebuilt. Note that the HTML and the PDF will be built at packaging time, and we will ship them with our source releases, so no regular user will run into this. How would you like to proceed?
> Integrate Docs into Release Process
> -----------------------------------
>
> Key: COUCHDB-1536
> URL: https://issues.apache.org/jira/browse/COUCHDB-1536
> Project: CouchDB
> Issue Type: Improvement
> Components: Documentation
> Affects Versions: 1.3
> Reporter: Dave Cottlehuber
> Assignee: Noah Slater
> Labels: docs,, make
> Fix For: 1.3
>
>
> List of outstanding tasks for integrating documentation into CouchDB build chain:
> - create DNS CNAME docs -> couchdb.readthedocs.org
> - add that to quicklinks on main site
> - extend makefile to: check for sphinx-build in PATH, & do the right thing in make dist
> - check if that works in VPATH build
> - update wiki /Documentation as required
--
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
[jira] [Commented] (COUCHDB-1536) Integrate Docs into Release
Process
Posted by "Noah Slater (JIRA)" <ji...@apache.org>.
[ https://issues.apache.org/jira/browse/COUCHDB-1536?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=13466172#comment-13466172 ]
Noah Slater commented on COUCHDB-1536:
--------------------------------------
I have started a thread about this on infra@ with the subject "Hosting docs in dist".
> Integrate Docs into Release Process
> -----------------------------------
>
> Key: COUCHDB-1536
> URL: https://issues.apache.org/jira/browse/COUCHDB-1536
> Project: CouchDB
> Issue Type: Improvement
> Components: Documentation
> Affects Versions: 1.3
> Reporter: Dave Cottlehuber
> Assignee: Noah Slater
> Labels: docs,, make
> Fix For: 1.3
>
>
> List of outstanding tasks for integrating documentation into CouchDB build chain:
> - create DNS CNAME docs -> couchdb.readthedocs.org
> - add that to quicklinks on main site
> - extend makefile to: check for sphinx-build in PATH, & do the right thing in make dist
> - check if that works in VPATH build
> - update wiki /Documentation as required
--
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
[jira] [Commented] (COUCHDB-1536) Integrate Docs into Release
Process
Posted by "Noah Slater (JIRA)" <ji...@apache.org>.
[ https://issues.apache.org/jira/browse/COUCHDB-1536?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=13508372#comment-13508372 ]
Noah Slater commented on COUCHDB-1536:
--------------------------------------
We have --disable-docs now. However, if you do not have the dependencies needed for docs, the docs will just silently not build or install.
We are building PDF for the official distribution artefacts. Default configuration for now.
Alexander, are you able to create a ticket that outlines what we should look at for fixing up the PDF quality for next release?
> Integrate Docs into Release Process
> -----------------------------------
>
> Key: COUCHDB-1536
> URL: https://issues.apache.org/jira/browse/COUCHDB-1536
> Project: CouchDB
> Issue Type: Improvement
> Components: Documentation
> Affects Versions: 1.3
> Reporter: Dave Cottlehuber
> Assignee: Noah Slater
> Priority: Blocker
> Labels: docs,, make
> Fix For: 1.4
>
>
> List of outstanding tasks for integrating documentation into CouchDB build chain:
> - create DNS CNAME docs -> couchdb.readthedocs.org
> - add that to quicklinks on main site
> - extend makefile to: check for sphinx-build in PATH, & do the right thing in make dist
> - check if that works in VPATH build
> - update wiki /Documentation as required
--
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
[jira] [Resolved] (COUCHDB-1536) Integrate Docs into Release
Process
Posted by "Noah Slater (JIRA)" <ji...@apache.org>.
[ https://issues.apache.org/jira/browse/COUCHDB-1536?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]
Noah Slater resolved COUCHDB-1536.
----------------------------------
Resolution: Fixed
> Integrate Docs into Release Process
> -----------------------------------
>
> Key: COUCHDB-1536
> URL: https://issues.apache.org/jira/browse/COUCHDB-1536
> Project: CouchDB
> Issue Type: Improvement
> Components: Documentation
> Affects Versions: 1.3
> Reporter: Dave Cottlehuber
> Assignee: Noah Slater
> Priority: Blocker
> Labels: docs,, make
> Fix For: 1.4
>
>
> List of outstanding tasks for integrating documentation into CouchDB build chain:
> - create DNS CNAME docs -> couchdb.readthedocs.org
> - add that to quicklinks on main site
> - extend makefile to: check for sphinx-build in PATH, & do the right thing in make dist
> - check if that works in VPATH build
> - update wiki /Documentation as required
--
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
[jira] [Updated] (COUCHDB-1536) Integrate Docs into Release Process
Posted by "Dave Cottlehuber (JIRA)" <ji...@apache.org>.
[ https://issues.apache.org/jira/browse/COUCHDB-1536?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]
Dave Cottlehuber updated COUCHDB-1536:
--------------------------------------
Priority: Blocker (was: Major)
> Integrate Docs into Release Process
> -----------------------------------
>
> Key: COUCHDB-1536
> URL: https://issues.apache.org/jira/browse/COUCHDB-1536
> Project: CouchDB
> Issue Type: Improvement
> Components: Documentation
> Affects Versions: 1.3
> Reporter: Dave Cottlehuber
> Assignee: Noah Slater
> Priority: Blocker
> Labels: docs,, make
> Fix For: 1.3
>
>
> List of outstanding tasks for integrating documentation into CouchDB build chain:
> - create DNS CNAME docs -> couchdb.readthedocs.org
> - add that to quicklinks on main site
> - extend makefile to: check for sphinx-build in PATH, & do the right thing in make dist
> - check if that works in VPATH build
> - update wiki /Documentation as required
--
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
[jira] [Reopened] (COUCHDB-1536) Integrate Docs into Release
Process
Posted by "Noah Slater (JIRA)" <ji...@apache.org>.
[ https://issues.apache.org/jira/browse/COUCHDB-1536?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]
Noah Slater reopened COUCHDB-1536:
----------------------------------
> Integrate Docs into Release Process
> -----------------------------------
>
> Key: COUCHDB-1536
> URL: https://issues.apache.org/jira/browse/COUCHDB-1536
> Project: CouchDB
> Issue Type: Improvement
> Components: Documentation
> Affects Versions: 1.3
> Reporter: Dave Cottlehuber
> Assignee: Noah Slater
> Priority: Blocker
> Labels: docs,, make
> Fix For: 1.4
>
>
> List of outstanding tasks for integrating documentation into CouchDB build chain:
> - create DNS CNAME docs -> couchdb.readthedocs.org
> - add that to quicklinks on main site
> - extend makefile to: check for sphinx-build in PATH, & do the right thing in make dist
> - check if that works in VPATH build
> - update wiki /Documentation as required
--
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
[jira] [Commented] (COUCHDB-1536) Integrate Docs into Release
Process
Posted by "Dirkjan Ochtman (JIRA)" <ji...@apache.org>.
[ https://issues.apache.org/jira/browse/COUCHDB-1536?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=13466767#comment-13466767 ]
Dirkjan Ochtman commented on COUCHDB-1536:
------------------------------------------
It's mostly the commit hook trick that makes it useful, I guess if we can replicate that on ASF infra that'd be okay too. However, I don't see much of a problem with hosting on RTD as long as we setup the CNAME -- many people won't even notice it's not ASF infra.
> Integrate Docs into Release Process
> -----------------------------------
>
> Key: COUCHDB-1536
> URL: https://issues.apache.org/jira/browse/COUCHDB-1536
> Project: CouchDB
> Issue Type: Improvement
> Components: Documentation
> Affects Versions: 1.3
> Reporter: Dave Cottlehuber
> Assignee: Noah Slater
> Labels: docs,, make
> Fix For: 1.3
>
>
> List of outstanding tasks for integrating documentation into CouchDB build chain:
> - create DNS CNAME docs -> couchdb.readthedocs.org
> - add that to quicklinks on main site
> - extend makefile to: check for sphinx-build in PATH, & do the right thing in make dist
> - check if that works in VPATH build
> - update wiki /Documentation as required
--
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
[jira] [Commented] (COUCHDB-1536) Integrate Docs into Release
Process
Posted by "Dave Cottlehuber (JIRA)" <ji...@apache.org>.
[ https://issues.apache.org/jira/browse/COUCHDB-1536?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=13489420#comment-13489420 ]
Dave Cottlehuber commented on COUCHDB-1536:
-------------------------------------------
Getting a failure during VPATH make due to missing PDFLATEX on OS X. I'm definitely not going to have that available on windows, @nslater can you make it behave nicely?
if test -z "`which makeinfo`"; then \
/zfs/shared/repos/couch/git/build-aux/missing makeinfo; \
fi
if test -n "`which sphinx-build`"; then \
sphinx-build -b texinfo -d doctrees -n -c /zfs/shared/repos/couch/git/share/doc/build/.. /zfs/shared/repos/couch/git/share/doc/build/../src ./texinfo; \
make -C texinfo info; \
else \
/zfs/shared/repos/couch/git/build-aux/missing sphinx-build; \
fi
Making output directory...
Running Sphinx v1.1.3
loading pickled environment... not yet created
building [texinfo]: all documents
updating environment: 25 added, 0 changed, 0 removed
reading sources... [100%] ssl
looking for now-outdated files... none found
pickling environment... done
checking consistency... done
processing CouchDB.texi... index intro api-basics range configuring ssl os-daemons http-proxying config_reference replication ddocs commonjs errors changes release api/reference api/configuration api/authn api/database api/documents api/design api/misc api/local api/dbmaint json-structure
resolving references...
writing... done
copying images... ../images/futon-overview.png ../images/futon-editdoc.png ../images/futon-editeddoc.png ../images/futon-createdb.png ../images/futon-replform.png
copying Texinfo support files... /Users/dch/tmp/couchdocs/share/doc/build/texinfo/Makefile done
build succeeded.
makeinfo --no-split -o 'CouchDB.info' 'CouchDB.texi'
CouchDB.texi:5: Warnung: nicht erkannter Kodierungsname „UTF-8“.
if test -z "`which pdflatex`"; then \
/zfs/shared/repos/couch/git/build-aux/missing pdflatex; \
fi
WARNING: 'pdflatex' is needed, and is missing on your system.
You might have modified some files without having the
proper tools for further handling them. Check the 'README' file,
it often tells you about the needed prerequisites for installing
this package. You may also peek at any GNU archive site, in case
some other package would contain this missing 'pdflatex' program.
make[4]: *** [pdf.stamp] Error 1
make[3]: *** [all-recursive] Error 1
make[2]: *** [all-recursive] Error 1
make[1]: *** [all-recursive] Error 1
make: *** [all] Error 2
> Integrate Docs into Release Process
> -----------------------------------
>
> Key: COUCHDB-1536
> URL: https://issues.apache.org/jira/browse/COUCHDB-1536
> Project: CouchDB
> Issue Type: Improvement
> Components: Documentation
> Affects Versions: 1.3
> Reporter: Dave Cottlehuber
> Assignee: Noah Slater
> Labels: docs,, make
> Fix For: 1.3
>
>
> List of outstanding tasks for integrating documentation into CouchDB build chain:
> - create DNS CNAME docs -> couchdb.readthedocs.org
> - add that to quicklinks on main site
> - extend makefile to: check for sphinx-build in PATH, & do the right thing in make dist
> - check if that works in VPATH build
> - update wiki /Documentation as required
--
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
[jira] [Commented] (COUCHDB-1536) Integrate Docs into Release
Process
Posted by "Noah Slater (JIRA)" <ji...@apache.org>.
[ https://issues.apache.org/jira/browse/COUCHDB-1536?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=13472231#comment-13472231 ]
Noah Slater commented on COUCHDB-1536:
--------------------------------------
You raise a good point. Let's come back to this when the docs are fully integrated. You guys might be right.
> Integrate Docs into Release Process
> -----------------------------------
>
> Key: COUCHDB-1536
> URL: https://issues.apache.org/jira/browse/COUCHDB-1536
> Project: CouchDB
> Issue Type: Improvement
> Components: Documentation
> Affects Versions: 1.3
> Reporter: Dave Cottlehuber
> Assignee: Noah Slater
> Labels: docs,, make
> Fix For: 1.3
>
>
> List of outstanding tasks for integrating documentation into CouchDB build chain:
> - create DNS CNAME docs -> couchdb.readthedocs.org
> - add that to quicklinks on main site
> - extend makefile to: check for sphinx-build in PATH, & do the right thing in make dist
> - check if that works in VPATH build
> - update wiki /Documentation as required
--
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
[jira] [Assigned] (COUCHDB-1536) Integrate Docs into Release
Process
Posted by "Noah Slater (JIRA)" <ji...@apache.org>.
[ https://issues.apache.org/jira/browse/COUCHDB-1536?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]
Noah Slater reassigned COUCHDB-1536:
------------------------------------
Assignee: Noah Slater
> Integrate Docs into Release Process
> -----------------------------------
>
> Key: COUCHDB-1536
> URL: https://issues.apache.org/jira/browse/COUCHDB-1536
> Project: CouchDB
> Issue Type: Improvement
> Components: Documentation
> Affects Versions: 1.3
> Reporter: Dave Cottlehuber
> Assignee: Noah Slater
> Labels: docs,, make
> Fix For: 1.3
>
>
> List of outstanding tasks for integrating documentation into CouchDB build chain:
> - create DNS CNAME docs -> couchdb.readthedocs.org
> - add that to quicklinks on main site
> - extend makefile to: check for sphinx-build in PATH, & do the right thing in make dist
> - check if that works in VPATH build
> - update wiki /Documentation as required
--
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
[jira] [Commented] (COUCHDB-1536) Integrate Docs into Release
Process
Posted by "Dave Cottlehuber (JIRA)" <ji...@apache.org>.
[ https://issues.apache.org/jira/browse/COUCHDB-1536?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=13466760#comment-13466760 ]
Dave Cottlehuber commented on COUCHDB-1536:
-------------------------------------------
I don't mind at all. The sphinx-build output is pretty much self-contained (the HTML version includes working search functionality, the other version Noah tried might not).
Dirkjan set it up, it saved me lots of time before I got sphinx working correctly.
> Integrate Docs into Release Process
> -----------------------------------
>
> Key: COUCHDB-1536
> URL: https://issues.apache.org/jira/browse/COUCHDB-1536
> Project: CouchDB
> Issue Type: Improvement
> Components: Documentation
> Affects Versions: 1.3
> Reporter: Dave Cottlehuber
> Assignee: Noah Slater
> Labels: docs,, make
> Fix For: 1.3
>
>
> List of outstanding tasks for integrating documentation into CouchDB build chain:
> - create DNS CNAME docs -> couchdb.readthedocs.org
> - add that to quicklinks on main site
> - extend makefile to: check for sphinx-build in PATH, & do the right thing in make dist
> - check if that works in VPATH build
> - update wiki /Documentation as required
--
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
[jira] [Commented] (COUCHDB-1536) Integrate Docs into Release
Process
Posted by "Noah Slater (JIRA)" <ji...@apache.org>.
[ https://issues.apache.org/jira/browse/COUCHDB-1536?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=13508851#comment-13508851 ]
Noah Slater commented on COUCHDB-1536:
--------------------------------------
Nope. Presumably, we covered that with the IP clearance.
Clouchbase no longer holds copyright, so there is no need to mention them in either NOTICE or LICENSE.
> Integrate Docs into Release Process
> -----------------------------------
>
> Key: COUCHDB-1536
> URL: https://issues.apache.org/jira/browse/COUCHDB-1536
> Project: CouchDB
> Issue Type: Improvement
> Components: Documentation
> Affects Versions: 1.3
> Reporter: Dave Cottlehuber
> Assignee: Noah Slater
> Priority: Blocker
> Labels: docs,, make
> Fix For: 1.4
>
>
> List of outstanding tasks for integrating documentation into CouchDB build chain:
> - create DNS CNAME docs -> couchdb.readthedocs.org
> - add that to quicklinks on main site
> - extend makefile to: check for sphinx-build in PATH, & do the right thing in make dist
> - check if that works in VPATH build
> - update wiki /Documentation as required
--
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
[jira] [Commented] (COUCHDB-1536) Integrate Docs into Release
Process
Posted by "Dave Cottlehuber (JIRA)" <ji...@apache.org>.
[ https://issues.apache.org/jira/browse/COUCHDB-1536?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=13490269#comment-13490269 ]
Dave Cottlehuber commented on COUCHDB-1536:
-------------------------------------------
Point taken, but can you add a --without-docs flag for configure? Or at least a --without-pdf-for-lazy-windows-packagers ?
My 0.02c, more & more people build directly from git tag checkouts (it's not just one solitary windows packager), especially while we are working on a new release branch. If possible building from git shouldn't require all tools for building an ASF release.
> Integrate Docs into Release Process
> -----------------------------------
>
> Key: COUCHDB-1536
> URL: https://issues.apache.org/jira/browse/COUCHDB-1536
> Project: CouchDB
> Issue Type: Improvement
> Components: Documentation
> Affects Versions: 1.3
> Reporter: Dave Cottlehuber
> Assignee: Noah Slater
> Labels: docs,, make
> Fix For: 1.3
>
>
> List of outstanding tasks for integrating documentation into CouchDB build chain:
> - create DNS CNAME docs -> couchdb.readthedocs.org
> - add that to quicklinks on main site
> - extend makefile to: check for sphinx-build in PATH, & do the right thing in make dist
> - check if that works in VPATH build
> - update wiki /Documentation as required
--
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
[jira] [Commented] (COUCHDB-1536) Integrate Docs into Release
Process
Posted by "Octavian Damiean (JIRA)" <ji...@apache.org>.
[ https://issues.apache.org/jira/browse/COUCHDB-1536?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=13466197#comment-13466197 ]
Octavian Damiean commented on COUCHDB-1536:
-------------------------------------------
Having the docs hosted on Apache infra would look more professional in my opinion. I have nothing against the current domain either though.
> Integrate Docs into Release Process
> -----------------------------------
>
> Key: COUCHDB-1536
> URL: https://issues.apache.org/jira/browse/COUCHDB-1536
> Project: CouchDB
> Issue Type: Improvement
> Components: Documentation
> Affects Versions: 1.3
> Reporter: Dave Cottlehuber
> Assignee: Noah Slater
> Labels: docs,, make
> Fix For: 1.3
>
>
> List of outstanding tasks for integrating documentation into CouchDB build chain:
> - create DNS CNAME docs -> couchdb.readthedocs.org
> - add that to quicklinks on main site
> - extend makefile to: check for sphinx-build in PATH, & do the right thing in make dist
> - check if that works in VPATH build
> - update wiki /Documentation as required
--
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
[jira] [Commented] (COUCHDB-1536) Integrate Docs into Release
Process
Posted by "Alexander Shorin (JIRA)" <ji...@apache.org>.
[ https://issues.apache.org/jira/browse/COUCHDB-1536?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=13490282#comment-13490282 ]
Alexander Shorin commented on COUCHDB-1536:
-------------------------------------------
Following my experience, to provide really good PDF build there is need to review docs very careful for each changes since sphinx-rst2pdf doesn't respect any typography rules and at least you'll get a big problems with page breaking (e.g. section header at the end of page, split code block for two pages etc.). To fix this, there is need to setup special latex page breakers markers and check that they breaks page correctly before build release PDF version. If you want to get PDF docs as just a fact without caring about result quality - that's ok to go with default state. If you still care about and want to provide nice and readable PDF docs - that's another non-trivial task to carry on, sometimes not compatible with formats.
> Integrate Docs into Release Process
> -----------------------------------
>
> Key: COUCHDB-1536
> URL: https://issues.apache.org/jira/browse/COUCHDB-1536
> Project: CouchDB
> Issue Type: Improvement
> Components: Documentation
> Affects Versions: 1.3
> Reporter: Dave Cottlehuber
> Assignee: Noah Slater
> Priority: Blocker
> Labels: docs,, make
> Fix For: 1.3
>
>
> List of outstanding tasks for integrating documentation into CouchDB build chain:
> - create DNS CNAME docs -> couchdb.readthedocs.org
> - add that to quicklinks on main site
> - extend makefile to: check for sphinx-build in PATH, & do the right thing in make dist
> - check if that works in VPATH build
> - update wiki /Documentation as required
--
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
[jira] [Commented] (COUCHDB-1536) Integrate Docs into Release
Process
Posted by "Noah Slater (JIRA)" <ji...@apache.org>.
[ https://issues.apache.org/jira/browse/COUCHDB-1536?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=13466169#comment-13466169 ]
Noah Slater commented on COUCHDB-1536:
--------------------------------------
The couchdb.readthedocs.org site looks cool.
However, my original plan (having not looked at our docs yet) was to host the docs here:
http://www.apache.org/dist/couchdb/docs/
I was thinking we could use a versioned directory for each release.
I would need to clear this with Infra before we went ahead.
So, do you still think we should use this 3rd party site? And if so, why?
I am not opposed to it, I just want a conversation about it.
> Integrate Docs into Release Process
> -----------------------------------
>
> Key: COUCHDB-1536
> URL: https://issues.apache.org/jira/browse/COUCHDB-1536
> Project: CouchDB
> Issue Type: Improvement
> Components: Documentation
> Affects Versions: 1.3
> Reporter: Dave Cottlehuber
> Assignee: Noah Slater
> Labels: docs,, make
> Fix For: 1.3
>
>
> List of outstanding tasks for integrating documentation into CouchDB build chain:
> - create DNS CNAME docs -> couchdb.readthedocs.org
> - add that to quicklinks on main site
> - extend makefile to: check for sphinx-build in PATH, & do the right thing in make dist
> - check if that works in VPATH build
> - update wiki /Documentation as required
--
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
[jira] [Commented] (COUCHDB-1536) Integrate Docs into Release
Process
Posted by "Benoit Chesneau (JIRA)" <ji...@apache.org>.
[ https://issues.apache.org/jira/browse/COUCHDB-1536?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=13490274#comment-13490274 ]
Benoit Chesneau commented on COUCHDB-1536:
------------------------------------------
do we really need to provide a PDF build ?
> Integrate Docs into Release Process
> -----------------------------------
>
> Key: COUCHDB-1536
> URL: https://issues.apache.org/jira/browse/COUCHDB-1536
> Project: CouchDB
> Issue Type: Improvement
> Components: Documentation
> Affects Versions: 1.3
> Reporter: Dave Cottlehuber
> Assignee: Noah Slater
> Priority: Blocker
> Labels: docs,, make
> Fix For: 1.3
>
>
> List of outstanding tasks for integrating documentation into CouchDB build chain:
> - create DNS CNAME docs -> couchdb.readthedocs.org
> - add that to quicklinks on main site
> - extend makefile to: check for sphinx-build in PATH, & do the right thing in make dist
> - check if that works in VPATH build
> - update wiki /Documentation as required
--
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
[jira] [Commented] (COUCHDB-1536) Integrate Docs into Release
Process
Posted by "Dave Cottlehuber (JIRA)" <ji...@apache.org>.
[ https://issues.apache.org/jira/browse/COUCHDB-1536?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=13508847#comment-13508847 ]
Dave Cottlehuber commented on COUCHDB-1536:
-------------------------------------------
OK, I built using the rebased & squashed docs + 1.3.x branch:
https://github.com/apache/couchdb/tree/1536-feature_add-docs
and there's the result of make distcheck here - I've not tested it but it did finish cleanly:
http://people.apache.org/~dch/dist/snapshots/20121203/
would be great if we can have a couple of eyes on the branch, and also a test of the resulting tar.gz in case it's embarrassingly dysfunctional.
> Integrate Docs into Release Process
> -----------------------------------
>
> Key: COUCHDB-1536
> URL: https://issues.apache.org/jira/browse/COUCHDB-1536
> Project: CouchDB
> Issue Type: Improvement
> Components: Documentation
> Affects Versions: 1.3
> Reporter: Dave Cottlehuber
> Assignee: Noah Slater
> Priority: Blocker
> Labels: docs,, make
> Fix For: 1.4
>
>
> List of outstanding tasks for integrating documentation into CouchDB build chain:
> - create DNS CNAME docs -> couchdb.readthedocs.org
> - add that to quicklinks on main site
> - extend makefile to: check for sphinx-build in PATH, & do the right thing in make dist
> - check if that works in VPATH build
> - update wiki /Documentation as required
--
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
[jira] [Updated] (COUCHDB-1536) Integrate Docs into Release Process
Posted by "Dave Cottlehuber (JIRA)" <ji...@apache.org>.
[ https://issues.apache.org/jira/browse/COUCHDB-1536?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]
Dave Cottlehuber updated COUCHDB-1536:
--------------------------------------
Fix Version/s: (was: 1.3)
1.4
> Integrate Docs into Release Process
> -----------------------------------
>
> Key: COUCHDB-1536
> URL: https://issues.apache.org/jira/browse/COUCHDB-1536
> Project: CouchDB
> Issue Type: Improvement
> Components: Documentation
> Affects Versions: 1.3
> Reporter: Dave Cottlehuber
> Assignee: Noah Slater
> Priority: Blocker
> Labels: docs,, make
> Fix For: 1.4
>
>
> List of outstanding tasks for integrating documentation into CouchDB build chain:
> - create DNS CNAME docs -> couchdb.readthedocs.org
> - add that to quicklinks on main site
> - extend makefile to: check for sphinx-build in PATH, & do the right thing in make dist
> - check if that works in VPATH build
> - update wiki /Documentation as required
--
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
[jira] [Commented] (COUCHDB-1536) Integrate Docs into Release
Process
Posted by "Benoit Chesneau (JIRA)" <ji...@apache.org>.
[ https://issues.apache.org/jira/browse/COUCHDB-1536?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=13508850#comment-13508850 ]
Benoit Chesneau commented on COUCHDB-1536:
------------------------------------------
shouldn't the NOTICE include some bits about couchbase?
> Integrate Docs into Release Process
> -----------------------------------
>
> Key: COUCHDB-1536
> URL: https://issues.apache.org/jira/browse/COUCHDB-1536
> Project: CouchDB
> Issue Type: Improvement
> Components: Documentation
> Affects Versions: 1.3
> Reporter: Dave Cottlehuber
> Assignee: Noah Slater
> Priority: Blocker
> Labels: docs,, make
> Fix For: 1.4
>
>
> List of outstanding tasks for integrating documentation into CouchDB build chain:
> - create DNS CNAME docs -> couchdb.readthedocs.org
> - add that to quicklinks on main site
> - extend makefile to: check for sphinx-build in PATH, & do the right thing in make dist
> - check if that works in VPATH build
> - update wiki /Documentation as required
--
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