Details
-
Epic
-
Status: Open
-
Major
-
Resolution: Unresolved
-
tech-debt
-
Secure SDK DOcs
-
To Do
-
12
Description
The intro articles in the SDK docs use insecure connections for a quick and easy start.
This should be eliminated from all but the most basic examples - and only kept there if it is essential for quick onboarding (and should be called out in the text and with a comment in the code).
For CE, so long as TLS is an EE-only feature, equivalents will have to be noted.
Note, a dockerised Server is now provided for Sample app, so only a passing mention needs to be made in the sample app docs.
Currently marked as SDK 3.3, this Epic may take longer, as we wait for CE to get TLS - to save having to do the workarounds above.
Attachments
Issue Links
- relates to
-
-
- Open
-
Gerrit Reviews
Activity
| Field | Original Value | New Value |
|---|---|---|
| Description |
The intro articles in the SDK docs use insecure connections for a quick and easy start.
This should be eliminated from all but the most basic examples - and only kept there if it is essential for quick onboarding (and should be called out in the text and with a comment in the code). |
The intro articles in the SDK docs use insecure connections for a quick and easy start.
This should be eliminated from all but the most basic examples - and only kept there if it is essential for quick onboarding (and should be called out in the text and with a comment in the code). For CE, so long as TLS is an EE-only feature, equivalents will have to be noted. In particular, for onboarding, {{couchbase://}} should be in a comment in the sample app, as an alternative for CE users, and called out in the docs. Currently marked as SDK 3.3, this may take longer, as we wait for CE to get TLS - to save having to do the workarounds above. |
| Description |
The intro articles in the SDK docs use insecure connections for a quick and easy start.
This should be eliminated from all but the most basic examples - and only kept there if it is essential for quick onboarding (and should be called out in the text and with a comment in the code). For CE, so long as TLS is an EE-only feature, equivalents will have to be noted. In particular, for onboarding, {{couchbase://}} should be in a comment in the sample app, as an alternative for CE users, and called out in the docs. Currently marked as SDK 3.3, this may take longer, as we wait for CE to get TLS - to save having to do the workarounds above. |
The intro articles in the SDK docs use insecure connections for a quick and easy start.
This should be eliminated from all but the most basic examples - and only kept there if it is essential for quick onboarding (and should be called out in the text and with a comment in the code). For CE, so long as TLS is an EE-only feature, equivalents will have to be noted. Note, a dockerised Server is now provided for Sample app, so only a passing mention needs to be made in the sample app docs. Currently marked as SDK 3.3, this Epic may take longer, as we wait for CE to get TLS - to save having to do the workarounds above. |
| Epic Name | Secure SDK DOcs | sec |
| Epic Name | sec | Secure SDK DOcs |
| Fix Version/s | sdk3.2-backlog [ 17245 ] | |
| Fix Version/s | sdk-3.3 [ 17246 ] |