Uploaded image for project: 'Couchbase .NET client library'
  1. Couchbase .NET client library
  2. NCBC-2500

Generate API documentation using DocFx via build system.

    XMLWordPrintable

Details

    • Story
    • Resolution: Fixed
    • Major
    • backlog-3.0
    • 3.0.1
    • docs
    • None
    • 1
    • SDK46: TTL Imp., Bdura, Docs, SDK48: FTS Score/Incl, Docs.

    Description

      DocFx is an open source, multiple platform (Win, Macos, Linux) code source documentation generator which is a vast improvement over the much older Sandcastle project which is Windows only.

      This story is to integrate DocFx into the Jenkins release build pipeline so that API documentation can done automatically as part of a release.

      Once generated, the documentation should be immediately uploaded to S3 (docs.couchbase.com/sdk-api/...) under a directory with the following naming convention: couchbase-net-client-X.Y.Z where X is the major, Y is the minor and Z is the patch. Read permissions will need to be set here as well on the entire directory.

      This is created as a story, because there are several steps that make up a complete solution and sub-tasks can be created as appropriate.

      Attachments

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

        Activity

          People

            richard.ponton Richard Ponton
            jmorris Jeff Morris
            Votes:
            0 Vote for this issue
            Watchers:
            4 Start watching this issue

            Dates

              Created:
              Updated:
              Resolved:

              Gerrit Reviews

                There are no open Gerrit changes

                PagerDuty