Details

    • DOC-2020-S24-Dec13, DOC-2020-S25-Jan03, DOC-2021-Jan17-S1, DOC-2021-Jan31-S2, DOC-2022-S6, DOC-2022-S7, DOC-2022-S8, DOC-2022-S9
    • 10

    Description

      Our SDK docs should assume a reasonable familiarity with the platform/language, appropriate to the SDK developer.
      However, the docs are used by others - testers, software architects, Couchbase field team - and for these, a little platform introduction, linked from the getting started page, is appropriate.
      To be added for each SDK as and when resources allow (not a priority for SDK3 GA date).

      Attachments

        Issue Links

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

          Activity

            By popular demand, we are expanding the Platform Help to all SDKs, and to incorporate the detail of the installation (currently, and a bit oddly, in the Release Notes section).

            I will look at PHP first.

            hakim.cassimally Hakim Cassimally added a comment - By popular demand, we are expanding the Platform Help to all SDKs, and to incorporate the detail of the installation (currently, and a bit oddly, in the Release Notes section). I will look at PHP first.

            Platform Help is now separate from installation.

            But should incorporate some details from Happy Path installation for people new to language?

            hakim.cassimally Hakim Cassimally added a comment - Platform Help is now separate from installation. But should incorporate some details from Happy Path installation for people new to language?

            But should incorporate some details from Happy Path installation for people new to language?

             
             
            Sure -  makes no sense to take people away from a beginner's doc, just to read `npm install` or whatever elsewhere.  

            richard.smedley Richard Smedley added a comment - But should incorporate some details from Happy Path installation for people new to language?     Sure -  makes no sense to take people away from a beginner's doc, just to read `npm install` or whatever elsewhere.  

            Did a little work on this, but found it very time-consuming. Where we can really add value is:

            • opinionated selection of tools (IDE, extensions, build tooling, module installation, watchers, linters, version managers etc.) and especially ones that are widely used by our users and developers.
            • Docs team not necessarily best placed to be determining this kind of thing?
              We should definitely share wisdom from e.g. SDK devs, DA, field, and others though.

            Assigning this one to Maria to further triage and prioritise.

            hakim.cassimally Hakim Cassimally added a comment - Did a little work on this, but found it very time-consuming. Where we can really add value is: opinionated selection of tools (IDE, extensions, build tooling, module installation, watchers, linters, version managers etc.) and especially ones that are widely used by our users and developers. Docs team not necessarily best placed to be determining this kind of thing? We should definitely share wisdom from e.g. SDK devs, DA, field, and others though. Assigning this one to Maria to further triage and prioritise.

            Agreed, in fact, initially when we setup the Platform Help page for .NET we had dev help to write it out I think.
            It's worth having engineering help with other SDKs, but this is currently not high on the priority list I guess.

            Hopefully we get to revisit this soon...

            maria.shodunke Maria Shodunke added a comment - Agreed, in fact, initially when we setup the Platform Help page for .NET we had dev help to write it out I think. It's worth having engineering help with other SDKs, but this is currently not high on the priority list I guess. Hopefully we get to revisit this soon...

            People

              maria.shodunke Maria Shodunke
              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