couchdb-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From "Ben Keen (JIRA)" <j...@apache.org>
Subject [jira] [Created] (COUCHDB-2449) Fix Documentation links within Fauxton
Date Sat, 08 Nov 2014 05:13:33 GMT
Ben Keen created COUCHDB-2449:
---------------------------------

             Summary: Fix Documentation links within Fauxton
                 Key: COUCHDB-2449
                 URL: https://issues.apache.org/jira/browse/COUCHDB-2449
             Project: CouchDB
          Issue Type: Bug
      Security Level: public (Regular issues)
          Components: Fauxton
            Reporter: Ben Keen


In the sidebar, there's a "Documentation" option. It appears to always link to this URL:
http://yoursite:8000/_utils/docs/intro/api.html#documents

That's a bit odd, I think. That location in the doc is specifically about Documents, which
is interesting, but not the only thing a person would be interested in.

Inside the API URL bar tray that appears on many pages, there's a little "?" icon next to
the title that links to a relevant documentation page. That's much more useful, but largely
hidden.

I suggest removing the Documentation page altogether from the sidebar, putting in a more prominent
"?" next to the title of the page ("Databases", "Config", "Replication" and others - any page
with a relevant corresponding doc page), and dropping the "?" from the API Url bar.

I won't tackle this until I get a +1 or two... seems a little aggressive without getting consensus.



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

Mime
View raw message