DOC-13726 add ide section #282
Conversation
RichardSmedley
left a comment
RichardSmedley
left a comment
There was a problem hiding this comment.
Hello @Pallavi-Janardhan
I fear you may have strayed a little from DOC-13726.
As requested, the task - DOC-13697 - was split into bite-sized sections.
This one was to bring the opening section into line with the other SDKs' docs.
It looks like that change is a tiny fraction of all that is included in this PR.
What's needed now is:
- A fresh PR for DOC-13726, containing only the changes related to that ticket.
- Have a read of my comments (without implementing the changes) and a think about what we aim to do when we make changes in the docs to improve a developer's understanding of using Couchbase and the SDKs.
- Note that Vale will give you many red lines under existing bits of the doc, but you can ignore them if they amount to substantially more than a drive-by fix. There is a lot of tech debt in the Node.js docs that needs addressing - and the priority has to be truthful, functional docs. Beyond that, fixing style and consistency cannot be efficiently done by making involved but piecemeal changes to single documents in one SDK. It is best done by improving earlier efforts to pull out common content across SDKs, and then to fill in remaining gaps. A giant task which should be ticketed separately.
Thank you for all of your efforts here - let's discuss the comments on the changes next time we meet.
| TIP: There's a *View* link to the complete sample code on GitHub above each of the snippets on these SDK pages, and a *Copy* icon to grab just the snippet shown. | ||
|
|
||
| NOTE: The code samples on this page use ESModules, but the Node.js SDK is fully compatible with CommonJS as well. Simply adjust the import syntax as needed. | ||
| NOTE: The code samples on this page use ESModules, but the Node.js SDK is fully compatible with CommonJS as well. Specify the import syntax as needed. |
There was a problem hiding this comment.
Whilst making a change here, it would also be a good idea to put in the line break for the new sentence. 👍
| ---- | ||
| Note, the client certificate for connecting to a Capella cluster is included in the SDK installation. | ||
| NOTE: SDK installation includes the client certificate for connecting to a Capella cluster. |
There was a problem hiding this comment.
This could be interpreted as saying that the cert is brought in as part of the installation process,
rather than simply being included in the npm package.
Perhaps:
The SDK includes...
| ---- | ||
| Note, the client certificate for connecting to a Capella cluster is included in the SDK installation. | ||
| NOTE: SDK installation includes the client certificate for connecting to a Capella cluster. |
| NOTE: SDK installation includes the client certificate for connecting to a Capella cluster. | ||
| -- | ||
| Self-Managed Couchbase Server (Javascript):: |
There was a problem hiding this comment.
Javascript --> JavaScript
| NOTE: SDK installation includes the client certificate for connecting to a Capella cluster. | ||
| -- | ||
| Couchbase Capella (Typescript):: |
There was a problem hiding this comment.
Presuming you ran Vale - did it show up all of the places where Javascript should be JavaScript,
and Typescript should be TypeScript?
May as well add in these changes, too. 👍
There was a problem hiding this comment.
No it didnt show. I will search for it and change it everywhere.
|
|
||
| Each document belongs to exactly one collection. | ||
| A document's ID is unique _within_ the collection. | ||
| Every document belongs to a collection. |
There was a problem hiding this comment.
Doesn't this remove the precision of the sentence?
There was a problem hiding this comment.
True may be! Should we go back to the original ?
| Each document belongs to exactly one collection. | ||
| A document's ID is unique _within_ the collection. | ||
| Every document belongs to a collection. | ||
| A document's ID is unique `within` the collection. |
There was a problem hiding this comment.
Whilst the style guide strongly dislikes italic emphasis,
we don't use monospace in this way.
| There is no relationship between collections in different scopes. | ||
| Each collection belongs to just one scope and | ||
| a collection's name is unique within the scope. | ||
| There's no relationship between collections in different scopes. |
There was a problem hiding this comment.
Sometimes the there is to there's change can dull the necessary emphasis that gives meaning.
| Each collection belongs to just one scope and | ||
| a collection's name is unique within the scope. | ||
| There's no relationship between collections in different scopes. | ||
| Each collection belongs to 1 scope and a collection's name is unique within the scope. |
| //// | ||
| == Next Steps | ||
| Now you're up and running, try one of the following: |
There was a problem hiding this comment.
Everything below here is in a commented out section.
Should we be changing it - or either deleting it wholesale, or looking to use part of it?
How about uncommenting the Next Steps above here instead?
Or at least those where it makes most sense to do so.
Doc Issue: DOC-13697
Added info about the IDE Plugins to the Hello World page, in the Node.js SDK doc.
Docs preview
Preview credentials