couchdb-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From "Andy Wenk (JIRA)" <j...@apache.org>
Subject [jira] [Commented] (COUCHDB-1863) Documentation link should be on top links of front page
Date Sun, 12 Oct 2014 11:42:33 GMT

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

Andy Wenk commented on COUCHDB-1863:
------------------------------------

Intro:
> Eventual consistency: my second option would be to link to wikipedia, but I think the
article on the Guide was so much, much, much better... I understand the need for deprecating
the guide, so I actually suggested what I think is a better protocol than throwing out the
baby with the bathwater: https://issues.apache.org/jira/browse/COUCHDB-2368
Or please suggest a better resource to link to.

see my comment at COUCHDB-2368 :). There is already a page in the docs http://docs.couchdb.org/en/1.6.1/intro/consistency.html

> The intro: how many intros do we need? There is one on couchdb.apache.org (that the user
is reading, like right now, and another one in the docs. At most, I'd take the wiki content
that is new and not redundant and stick it back in the intro of chapter 1 in the docs.

This is a good question. We now have three intro's: One on couchdb.apache.org, one in the
docs and one in the new wiki. I think we need it on couchdb.apache.org but we could / should
consolidate the docs and new wiki page. I think the reason why we have these intros is, that
they are targeting different intentions. couchdb.apache.org is a high level intro and new
wiki and docs is more in depth.  

> The technical overview is already on the docs, so I linked there: http://docs.couchdb.org/en/latest/intro/overview.html

perfect

> The "basics" guides: A problem with that is the wiki becomes stale, and the "quickstart
guides" are the entry point into the project for naive users, who'll be befuddled. But the
quickstart guides have a lot of good content too. I'm just thinking of where they would land
in the new wiki. Of course, this is part of:
https://issues.apache.org/jira/browse/COUCHDB-2350?jql=project%20%3D%20COUCHDB%20AND%20created%3E%3D-1w%20ORDER%20BY%20created%20DESC
For now, I'd keep this link here, push the new frontpage (which is better than it was and,
after all, issue 1863 has been finally resolved), and then come back and change the wiki links
as issue 2350 requires before resolution.

yup - that's what I meant also ...

So I don't see that basically "... disagree on some of your suggested edits ...". I think
we are swimming in the same fish bowl :)

> Documentation link should be on top links of front page
> -------------------------------------------------------
>
>                 Key: COUCHDB-1863
>                 URL: https://issues.apache.org/jira/browse/COUCHDB-1863
>             Project: CouchDB
>          Issue Type: Bug
>          Components: Website
>            Reporter: Dale Harvey
>            Assignee: Javier Candeira
>
> Its about the most important link there and nobody (including me) can find it.
> Can send in a patch



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

Mime
View raw message