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

Review and remove old duplicate tools reference pages

    XMLWordPrintable

Details

    • Bug
    • Resolution: Fixed
    • Major
    • None
    • Alice, Mad Hatter, Cheshire-Cat
    • tools
    • 1

    Description

      As part of the work in DOC-5647, it was identified that some tools reference pages were still being built from old source in the docs-server repo, even though these pages had moved over to being built from the same source as the command line help files. This was corrected by deleting the duplicate/outdated versions from the docs-server repo, updating the nav with the new paths, and adding page aliases to the new shared source files in the couchbase-cli repo.

      However, as a precautionary measure, the old source files were copied to the following directory in the couchbase-cli repo: https://github.com/couchbase/couchbase-cli/tree/master/docs/modules/cli/pages/cbtools/old

      As a result, these pages are still being built into the docs site: https://docs.couchbase.com/server/current/cli/cbtools/old/cbbackup-tool.html

      They are not referenced in the nav anywhere, but they do appear in site search and probably messing with SEO.

      These duplicate pages should be removed from each branch going back to when they were introduced in 6.5.

      • Short-term fix: Make Antora ignore these files by adding a period to the beginning of every filename in docs/modules/cli/pages/cbtools/old/
      • Long-term fix (if desired): Compare the old pages with the new shared-source ones to see if there's anything that's missing and worth adding back to the shared-source pages. Then delete the old pages.

      Attachments

        Issue Links

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

          Activity

            People

              eric.schneider Eric Schneider (Inactive)
              eric.schneider Eric Schneider (Inactive)
              Votes:
              0 Vote for this issue
              Watchers:
              1 Start watching this issue

              Dates

                Created:
                Updated:
                Resolved:

                Gerrit Reviews

                  There are no open Gerrit changes

                  PagerDuty