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

Admonition in SDK txn pages

    XMLWordPrintable

Details

    • DOC-2022-S8
    • 1

    Attachments

      Issue Links

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

        Activity

          simon.dew Simon Dew added a comment -

          Richard Smedley – the following pages both exist, and both contain almost identical information:

          1. Learn › Data › Transactions
          2. SDK Extension Libraries › Distributed ACID Transactions

          They don't use partials. Of the two №1 seems more up-to-date. Both contain broken links; №2 contains broken images. I'm not sure why both of these pages exist; maybe the second one made sense when transactions were a development preview, but now that they are a mainstream feature within Couchbase Server, I don't know why we need №2. Do you think it's worth getting rid of it (with redirects of course) as part of this issue?

          simon.dew Simon Dew added a comment - Richard Smedley – the following pages both exist, and both contain almost identical information: Learn › Data › Transactions SDK Extension Libraries › Distributed ACID Transactions They don't use partials. Of the two №1 seems more up-to-date. Both contain broken links; №2 contains broken images. I'm not sure why both of these pages exist; maybe the second one made sense when transactions were a development preview, but now that they are a mainstream feature within Couchbase Server, I don't know why we need №2. Do you think it's worth getting rid of it (with redirects of course) as part of this issue?
          simon.dew Simon Dew added a comment -

          The Learn › Data › Transaction page contains a lot more code examples than we usually have in the Learn section, and includes a lot of links to the SDK documents which should more naturally be links to elsewhere in the Learn section. I think the "Distributed ACID Transactions" page came first, and was copied into the Learn section when transactions became a mainstream feature, which would explain it

          simon.dew Simon Dew added a comment - The Learn › Data › Transaction page contains a lot more code examples than we usually have in the Learn section, and includes a lot of links to the SDK documents which should more naturally be links to elsewhere in the Learn section. I think the "Distributed ACID Transactions" page came first, and was copied into the Learn section when transactions became a mainstream feature, which would explain it
          simon.dew Simon Dew added a comment -

          Richard Smedley I added an admonition to Learn › Data › Transactions as part of DOC-9642. I also fixed the broken links on that page. I'll leave it to you to look at the SDK pages (with code samples if necessary?) and work out what to do about SDK Extension Libraries › Distributed ACID Transactions.

          simon.dew Simon Dew added a comment - Richard Smedley I added an admonition to Learn › Data › Transactions as part of DOC-9642 . I also fixed the broken links on that page. I'll leave it to you to look at the SDK pages (with code samples if necessary?) and work out what to do about SDK Extension Libraries › Distributed ACID Transactions .
          richard.smedley Richard Smedley added a comment - - edited

          Of the two №1 seems more up-to-date. Both contain broken links; №2 contains broken images. I'm not sure why both of these pages exist; maybe the second one made sense when transactions were a development preview, but now that they are a mainstream feature within Couchbase Server, I don't know why we need №2. Do you think it's worth getting rid of it (with redirects of course) as part of this issue?

           

          Simon Dew  №2 was a PM request as an SDK-neutral landing page to be linked from blogs about transactions - and not subject to the changes that Server docs can undergo.
          Note, the other extension libs to the SDKs also have pages there - RTO and encryption.

           

          A more in-depth history is available if you ever have the time.   

           

          In future, we may be able to re-use content from the very similar Server page, and this is probably what will happen.

          richard.smedley Richard Smedley added a comment - - edited Of the two №1 seems more up-to-date. Both contain broken links; №2 contains broken images. I'm not sure why both of these pages exist; maybe the second one made sense when transactions were a development preview, but now that they are a mainstream feature within Couchbase Server, I don't know why we need №2. Do you think it's worth getting rid of it (with redirects of course) as part of this issue?   Simon Dew   №2 was a PM request as an SDK-neutral landing page to be linked from blogs about transactions - and not subject to the changes that Server docs can undergo. Note, the other extension libs to the SDKs also have pages there - RTO and encryption.   A more in-depth history is available if you ever have the time.       In future, we may be able to re-use content from the very similar Server page, and this is probably what will happen.
          simon.dew Simon Dew added a comment -

          Converted this from a subtask to a bug so I can remove the parent issue from the current sprint.

          simon.dew Simon Dew added a comment - Converted this from a subtask to a bug so I can remove the parent issue from the current sprint.

          The https://docs.couchbase.com/sdk-extensions/distributed-acid-transactions.html page is ready to switch to using the Server concept page content as soon as 7.1 moves into the prod docs.

          richard.smedley Richard Smedley added a comment - The https://docs.couchbase.com/sdk-extensions/distributed-acid-transactions.html page is ready to switch to using the Server concept page content as soon as 7.1 moves into the prod docs.

          People

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

            Dates

              Created:
              Updated:
              Resolved:

              Gerrit Reviews

                There are no open Gerrit changes

                PagerDuty