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

Impliment best-practice method for referencing docs pages within Avengers and Couchbase Server UIs

    XMLWordPrintable

Details

    • 1

    Description

      There will be several occasions where the UIs of Couchbase products will include links to documentation pages. Simply including the current page URL may not be desirable, for example 1.) the URL scheme may change at some point, 2.) it places the burden on the engineering team to make code changes to every URL with every release, 3.) post-release redirects are potentially more complicated. This feature will also be beneficial when we archive older releases of documentation, or if we ever need to provide an offline doc set.

       

      We want to make sure we're using the best method for linking to an Antora site from Couchbase UIs. This might be done with some sort of token system.

      Attachments

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

        Activity

          People

            Unassigned Unassigned
            eric.schneider Eric Schneider (Inactive)
            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