couchdb-dev mailing list archives

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

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

Javier Candeira commented on COUCHDB-1863:
------------------------------------------

Hi [~andywenk]

We disagree on some of your suggested edits. Maybe it would be better at this point if we
took the conversation to irc, and have nslater also in it (as CouchDB developer interested
in the documentation and as coauthor of the Guide).

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.
- Move links to wiki: 
    * 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 and stick it back in the intro of point 1 in the docs.
    * The technical overview is already on the docs, so I linked there: http://docs.couchdb.org/en/latest/intro/overview.html
    * 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.

Documentation: 
- logging: fixed
- what's new: fixed
- Planet: I suggest we give Planet more power instead of deprecating it. Joan agrees. Have
not deleted link.

Contribute:
- I'd keep the link to the old wiki, push (because this front page is already better than
the live one), then, per issue 2350, fix wiki, then change wiki link here. However, for some
links, like the books page, I am already linking to the new wiki, since I already fixed that
one.

> 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