search

couchbaselabs / cbft

*THIS PROJECT HAS MOVED* from couchbaselabs TO: https://github.com/couchbase/cbft -- no further development will be done here on couchbaselabs/cbft
Other
27 stars 5 forks source link

online docs / bleve query string syntax help has content level discontinuity #113

Open steveyen opened 9 years ago

steveyen commented 9 years ago

During usability test... cbft lazily points to the bleve query string syntax page. That page in turn has links down to API (go) level concepts, but found out that a new user doesn't distinguish between that "level" jump and gets confused.

Maybe can ship a snapshot of that page and scrub out the secondary links to API stuff (but at the cost of more maintenance when the query syntax content changes.

Or can improve the original bleve query string syntax page to be clearer about what's going on.

steveyen commented 9 years ago

And, actually, docs in bleve might be moving to a new place off of the github wiki. When it does got to update not only...

https://github.com/couchbaselabs/cbft/blob/master/pindex_bleve.go#L110

...but also any pointers from cbft's docs

WillGardella commented 9 years ago

Just a +1 to say that all links to the wiki in the admin UI are now broken so it's somewhat confusing. It took me a second to figure out what was going on because instead of getting an error message, clicking the link jumps to a wiki page with the appropriate title but no content (Create this Page).