Uploaded image for project: 'Couchbase Server'
  1. Couchbase Server
  2. MB-9680

Verify notes are formatted correctly on new docs website

    XMLWordPrintable

Details

    • Bug
    • Resolution: Fixed
    • Major
    • 2.2.0
    • 2.2.0
    • None
    • Security Level: Public
    • None
    • TP Sprint 18 Dec - 31 Dec 2013, TP Sprint Jan 1 - 14 2014, TP Sprint Jan 15-28 2015

    Description

      When the documentation set was converted from docbook to markdown, callouts such as notes, warnings, tips, and best practices lost their special formatting. The pages on the current documentation website need to be compared with the PDFs from the old site to find the callouts that need to be reformatted.

      Start with the Couchbase Server 2.2 manual (and use the 2.1 PDF as the basis for the comparison). The next one should be the Couchbase Developer Guide 2.2. After those, we can decide how far back to take it.

      When doing the comparison, in the PDF, please use the annotation feature to mark the problem callouts. That will make it easier to find the places that will need to be changed in the 2.5 documentation.

      Please fix the callouts by using the HTML markup for callouts.

      Attachments

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

        Activity

          People

            gwenleong Gwen Leong (Inactive)
            akurtzman Amy Kurtzman (Inactive)
            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