Hi everyone,

Just a quick announcement that CouchDB docs are now part of the main
CouchDB repo in src/docs as discussed in
https://lists.apache.org/thread/x4lc6vhthj1vkt2xpd0ox5osh959qsc4. The
other major change was upgrading to the latest Shinx 5.1.1 package.

The two relevant PRs are:
  * https://github.com/apache/couchdb/pull/4164
  * https://github.com/apache/couchdb/pull/4174

One of the objections to integrating the docs was the docs CI ran much
quicker, and we wouldn't want to lose that. It turns out we were able
to "fast-forward" the CI for docs only changes. How that happens can
be seen in https://github.com/apache/couchdb/pull/4164#issuecomment-1239442611

Some of the benefits of this change are:
   * Easier to create feature PRs: it can be a single commit, updating
both the code and the docs.
   * Easier to synchronize docs and code changes, especially during
the release process.
   * Faster ./configure runs, as it doesn't have to clone a separate docs repo.
   * Easier to set up and run doc builds. There is a `./setup.sh`
script which should create the python virtualenv and install all the
requirements.
   * Some of the sphinx extensions have been cleaned up: for instance,
httpdomain is a proper pip dependency now, as opposed being vendored
in.
   * "Edit on Github'' link on the documentation front page now works
and points to the src/docs readme file.

Thanks to Ronny, Jay, Jan, and everyone else who participated for
their help with ideas and PR reviews!

Cheers,
-Nick

Reply via email to