Details
-
Task
-
Resolution: Incomplete
-
Major
-
None
-
None
Description
As per Perry's feedback, Chin requested to add this task. See email below.
___________________________________
From Chin:
Yes and we will need to figure out how to document FDB vs Plasma as well as soon as we have a decision on Plasma for 5.0.
The other section that requires updates is the concepts & architecture sections.
I want to have these sections updated by Beta2 if possible, but definitely by GA.
Shilpa, can you please add the gaps identified by Perry to the list of doc tasks?
- Chin
______________________________________________
From: Perry Krug <perry@couchbase.com>
Date: Tuesday, May 2, 2017 at 6:53 AM
To: Chin Hong <chin@couchbase.com>
Cc: Perry Krug <perry@couchbase.com>
Subject: Re: Index Replication documentation
I've finished a high-level review but there are still a few high-level items that I think need addressing. I discussed some of these with Matt already, but I guess the question is whether we are going to prioritize them or not:
- The CREATE/BUILD/DROP INDEX pages need a bit of an overhaul to make them easier to read and understand. CREATE probably needs the most work, the others are fairly straightforward
- The main "GSI for N1QL" page needs quite a bit of work. There's some basic ordering/cleanup that needs to happen, but there's also some extremely confusing content about halfway through that repeats info from above and then weaves in other topics. I have a feeling that the "architecture" got mixed with the "management" and needs to be split out again.
- There's a lot of opportunity for better cross-linking and "related" information
- Once the content makes sense and is in a good flow, then this needs to be reviewed again for grammar and spelling. Overall it's in pretty good shape, but there are definitely a few typos/mis-wording that stand out.
Perry