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

Add ids to headings for SEO and Linkability

    XMLWordPrintable

Details

    • Improvement
    • Resolution: Fixed
    • Critical
    • Alice
    • None
    • seo
    • None

    Description

      For both SEO and giving external navigation to users, we really need IDs on sections in the DITA markup. This is a major chore, but one that pays big dividends.

      Without this:
      1) Search Engines cannot link users directly to major sections of the documentation, like "Configuring Logging". Search engines use anchors to render direct links to sections for users. See https://www.searchenginepeople.com/blog/anchor-links.html for one writeup on this.
      2) Users like myself cannot link deeply into a document when referring to it in an email, a forums post, etc. This makes for a poor UX. The user has to click and then scroll around.

      I know an issue was filed for this long ago. It was discussed as a need in the 4.0 docs, then again in the 4.5 docs. It appears to have been closed without fixing it.

      I added some ids at one point as an example, though the generated IDs have some extra dita junk as can be seen in this screenshot:

      Attachments

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

        Activity

          People

            amarantha.kulkarni Amarantha Kulkarni (Inactive)
            ingenthr Matt Ingenthron
            Votes:
            0 Vote for this issue
            Watchers:
            3 Start watching this issue

            Dates

              Created:
              Updated:
              Resolved:

              Gerrit Reviews

                There are no open Gerrit changes

                PagerDuty