couchdb-dev mailing list archives

On Thu, May 9, 2013 at 12:53 PM, Robert Newson <rnewson@apache.org> wrote:
> I'm -0.9 (see http://www.apache.org/foundation/voting.html) on
> switching to Confluence. The choice of wiki technology is a tiny
> factor, in my opinion. No wiki is useful without active maintenance.
> Unless there's a horde of editors just waiting for the switch before
> they'll help out, I think it's a distraction from the real issue.
I couldn't agree more.
On Fri, May 17, 2013 at 8:48 PM, Paul Okstad <pokstad@gmail.com> wrote:
> Sphinx is a great tool, but it still doesn't have the user friendliness or
> social features of Confluence. What I'm suggesting is a way to get more
> involvement from less-technical members of the CouchDB community. Sphinx
> could be a great way to host official "strict" docs, but Confluence would
> be a great way for non-couch-devs to provide use cases and higher level
> documentation to total noobs. While I miss the markup removed in
> Confluence, it has lowered the barrier to people who don't know the mark up
> differences from wiki system to wiki system. It might be useful to have a
> dual-wiki approach: one for strict API docs tied to source code and one for
> casual and end user provided articles. I'm really surprised that the
> current source code hosted documentation isn't linked to from the wiki.
> Also, maybe I'm just talking too much :D
I think you're underestimating the user-friendliness of Sphinx and
probably also the level of technical knowledge of the average CouchDB
user. As pretty much all CouchDB users are actually software
developers, most of them should be able to handle reStructuredText in
their editor (and even if they don't, just writing some text into
Notepad is pretty easy).
On Sat, May 18, 2013 at 5:40 PM, Noah Slater <nslater@apache.org> wrote:
> 1) Yes! Let's get the docs/ sorted out! Moving NEWS/CHANGES into them.
> Moving CouchDB: The Definitive Guide into them. Incorporating the docs into
> our merge and release procedure. Drumming up a docs team! (Dave! Dirkjan!
> Alexander! All the exclamation points!)
Yes, I expect to spend a bunch of time on this.
Cheers,
Dirkjan