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

Couchbase Lite release notes are often incomplete / illogical

    XMLWordPrintable

Details

    • Task
    • Resolution: Fixed
    • Major
    • None
    • None
    • couchbase-lite
    • None

    Description

      Reviewing the release notes for CBL, I am finding that there is often versions completely missing from some releases. These can sometimes be found elsewhere, but this makes the release notes follow a somewhat illogical pattern and need to be either tidied up or more actively kept up to date.

      For example, 3.0.15 was released in November 2023 for CBL C as we can see from the github and Downloads page. This also appears in the 3.0 release notes as expected:

      https://docs.couchbase.com/couchbase-lite/3.0/c/releasenotes.html

      But, in the 3.1 release notes it doesn't exist. While this might not seem like a problem in its own right as its a 3.0 release, we include all of the 3.0 releases PRIOR to 3.1 within these release notes, making it appear that 3.0.15 doesn't exist when you check the current release notes.

      We should either be consistent with our release notes, leaving 3.0 and 3.1 release notes within their respective version pages (so remove 3.0 from the 3.1 release notes), or we need to be more active and continue to keep the current page with releases that are from a prior minor release. This has been causing confusion for some people and creates the appearance of our docs/releases being inconsistent.

      Attachments

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

        Activity

          People

            elliot.hunter Elliot Hunter
            thomas.dotters Thomas Dotters
            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