[
https://issues.apache.org/jira/browse/COUCHDB-2449?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel
]
Ben Keen updated COUCHDB-2449:
------------------------------
Description:
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 location in the doc is specifically about Documents, which is interesting,
but doesn't feel like the place a primary Documentation link should go. In
addition, having that nav item link to an off-script page also feels rather
jolting.
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 one of two things:
1. 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.
2. Leaving the Documentation sidebar item there, but have it link to a page
within Fauxton. That would have a (short) blurb introducing the documentation,
with a few key links. It could also points out the "?" links suggested in #1
above (which I think it's a pretty good idea to add in one form or other).
I won't tackle this until I get a +1 or two... seems a little aggressive
without getting consensus.
was:
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.
> 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
> Assignee: 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 location in the doc is specifically about Documents, which is
> interesting, but doesn't feel like the place a primary Documentation link
> should go. In addition, having that nav item link to an off-script page also
> feels rather jolting.
> 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 one of two things:
> 1. 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.
> 2. Leaving the Documentation sidebar item there, but have it link to a page
> within Fauxton. That would have a (short) blurb introducing the
> documentation, with a few key links. It could also points out the "?" links
> suggested in #1 above (which I think it's a pretty good idea to add in one
> form or other).
> 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)
