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

Updates to Contributor's Guide

    XMLWordPrintable

Details

    • Task
    • Resolution: Fixed
    • Major
    • 6.6.1
    • 5.x Doc Updates, 6.x Doc Updates
    • docs-site
    • None

    Description

      Updates to documentation Contributor's Guide following documentation style and tone discussions.

      Don’t use link: at the start of link macros if the URL makes it clear
      If the URL is repeated on the page, or is extraordinarily long, use a doc attribute for the URL
      External links should all have ^
      when using callouts, instead of using the <1>, <2> notation, we can instead use <.>. This method auto numbers the callouts
      The callout example in the contributor's guide should be marked AsciiDoc

      Attachments

        Issue Links

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

          Activity

            People

              simon.dew Simon Dew
              simon.dew Simon Dew
              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