Details
-
Task
-
Resolution: Fixed
-
Major
-
watson
-
None
Description
From: Eben Haber <eben@couchbase.com>
Date: Tuesday, June 21, 2016 at 3:43 PM
To: Amarantha <amarantha.kulkarni@couchbase.com>
Subject: Re: Watson Documentation on Staging Site
Hi Amarantha,
Here are some comments that came up as I perused the documentation, in no particular order:
· In the section on “Running your first N1QL Query”, the first appearance of ‘cbq’ is ‘below the fold’, and there is no mention of the query workbench. I think you should say where queries can be executed right near the top, e.g.:
N1QL embraces the JSON document model and uses SQL-like syntax. In N1QL, you operate on JSON documents, and the result of your operation is another JSON document. N1QL queries can be run on the web from the Couchbase Administrative Console, or from the command line with the cbq tool.
Then below you might want to mention how to navigate to the Query Workbench, in addition to giving the path for cbq.
· In the Query Workbench section is some text that probably should be removed for GA: “Important: This is a beta version of Couchbase Server 4.5 and is intended for development purposes only. We consider beta releases to have some rough edges and bugs, and may change significantly before the final GA release. This release is not supported in production.”
· Under “Query History”, change, “The tool maintains a history of all the queries executed in a given session.” -> “The tools maintains a history of the queries executed.” I think this change is needed since the history is persistent across sessions. Also, as far as I can tell, clearing the browser history does not always clear the history, it depends on which options you select. So I think the Note on clearing browser history may not be needed.
· Under “Support for N1QL INFER statements”, the “infer” statement is now a full-fledged part of N1QL, not just a preview, but only in the Enterprise Edition. Maybe this section should be in the N1QL portion of the manual? Perhaps move the “infer” section to be under “Bucket Analysis”, saying that “…bucket analysis is based on the N1QL infer statement, which you can run manually to get more detailed results…”?
–
Eben M. Haber