Uploaded image for project: 'Couchbase Documentation'
  1. Couchbase Documentation
  2. DOC-8697

TLS default for SDK Docs

    XMLWordPrintable

Details

    • 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

          No reviews matched the request. Check your Options in the drop-down menu of this sections header.

          Activity

            richard.smedley Richard Smedley created issue -
            richard.smedley Richard Smedley made changes -
            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.
            richard.smedley Richard Smedley made changes -
            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.
            richard.smedley Richard Smedley made changes -
            Epic Name Secure SDK DOcs sec
            richard.smedley Richard Smedley made changes -
            Epic Name sec Secure SDK DOcs
            richard.smedley Richard Smedley made changes -
            Fix Version/s sdk3.2-backlog [ 17245 ]
            Fix Version/s sdk-3.3 [ 17246 ]
            richard.smedley Richard Smedley made changes -
            Link This issue relates to DOC-8776 [ DOC-8776 ]

            People

              richard.smedley Richard Smedley
              richard.smedley Richard Smedley
              Votes:
              0 Vote for this issue
              Watchers:
              3 Start watching this issue

              Dates

                Created:
                Updated:

                Gerrit Reviews

                  There are no open Gerrit changes

                  PagerDuty