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 Thu, 09 Oct 2014 07:01:34 GMT

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

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

First of all: where can I find a repertory of icons so I can add new ones?

> Jan Lehnardt the arrow thing might be a good way to differentiate the link, you're right.
Either that, or we completely re-think the nav bar, and make all the links external. (Just
spit-balling here.) For example, we could link to the docs, then the blog, and leave it at
that. (Any other major properties we want to highlight?) I mean, it's a small page. Easy to
scroll down and find the rest.

At first blush, I'd make the Documentation toplink into an internal link that takes the visitor
to a section with little text (two lines) and just a number of links:

- Documentation (repeated, I know): explains what's in it, links to docs.couchdb.org
- Wiki: Explains why there is a separate wiki, links to the wiki
- Blog: 
- Planet: 
- Guide, if we still care about it.

Blog becomes subsumed into the documentation section.

> I agree with you Javier, that the page is sort of a bit hard to read. What are your thoughts
on improving that? Unfortunately, design is not my strong point. (Though I am happy to have
opinions about other people's efforts, haha.)

I don't know. I wrote the Learn and Discuss part after the Contribute part, which I think
is pretty great, just too long. I also think that now we better work with what we have, rather
than redesigning the docs page again. For me, the most important thing would be to make sure
that people don't get contradicting or stale information:

- clearing up the wikis so only relevant and up to date pages show up.
- 301'ing content so the relevant stuff bubbles up to the top of google results.
- cleaning up all the links to the old wiki in the docs page.

> I don't have time to work on this ticket. 

I have a lot of work this week, but I'm starting a new job next week. That's why I wanted
to get a lot done now.

> But I really like the work you've done so far Javier. Please be our guest and keep working
on this if you have the time. And don't worry about the commit bit stuff. Everybody's contributions
are equally valid. (For real.) I'll land your patch for you as soon as it's ready.

It's just that I think editing text by proxy doesn't work so good. I've worked in media, and
I know that at some point the best thing is for the editor to stop giving notes and type the
final fixes themselves. So I'm not worried about the commit bit, I just think the person giving
final approval should also give the final touches.

---

The main problem, however, is in fitting something like a separate docs site in the top links
and the design model for the page. The page design is responsive, so we could put in more
links and find other media query breakpoints at which to put the links in two rows, or make
the logo smaller and all the links under it, or something. I'll mull it over.

> 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: Noah Slater
>
> 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