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

Docs: better cross linking throughout documentation

    Details

    • Type: Improvement
    • Status: Closed
    • Priority: Major
    • Resolution: Fixed
    • Affects Version/s: 2.0
    • Fix Version/s: None
    • Component/s: None
    • Security Level: Public
    • Labels:
      None

      Description

      I know there are some parallel efforts going on, but wanted to call out a specific example to make sure that the needs are met.

      On this page: http://www.couchbase.com/docs/couchbase-manual-1.8/couchbase-introduction-architecture-quotas.html

      It makes sense to cross link to a section for "how" to change the quotas.

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

        Activity

        Hide
        perry Perry Krug added a comment -

        Just like this page (http://www.couchbase.com/docs/couchbase-manual-1.8/couchbase-admin-tasks-quotas.html) should be cross-linked back to the description about the quotas.

        Show
        perry Perry Krug added a comment - Just like this page ( http://www.couchbase.com/docs/couchbase-manual-1.8/couchbase-admin-tasks-quotas.html ) should be cross-linked back to the description about the quotas.
        Hide
        kzeller kzeller added a comment -

        Fixed this instance in 1.8 and 2.0:

        https://github.com/couchbase/docs/commit/dc7d7bcf04238a932aa2abbd92243dd6a65ee6eb

        https://github.com/couchbase/docs/commit/c170b7dbbf65321ef1b4d4721cf63448e0c164c5

        Closing this general ticket on improving cross references. This is an ongoing maintenance activity whenever a ticket comes in to fix grammer, content, information in any section of any guide. At that time we make checks for relevant cross references to- and from- for the section and then make them.

        Show
        kzeller kzeller added a comment - Fixed this instance in 1.8 and 2.0: https://github.com/couchbase/docs/commit/dc7d7bcf04238a932aa2abbd92243dd6a65ee6eb https://github.com/couchbase/docs/commit/c170b7dbbf65321ef1b4d4721cf63448e0c164c5 Closing this general ticket on improving cross references. This is an ongoing maintenance activity whenever a ticket comes in to fix grammer, content, information in any section of any guide. At that time we make checks for relevant cross references to- and from- for the section and then make them.
        Hide
        kzeller kzeller added a comment -

        Fixed this instance in 1.8 and 2.0:

        https://github.com/couchbase/docs/commit/dc7d7bcf04238a932aa2abbd92243dd6a65ee6eb

        https://github.com/couchbase/docs/commit/c170b7dbbf65321ef1b4d4721cf63448e0c164c5

        Closing this general ticket on improving cross references. This is an ongoing maintenance activity whenever a ticket comes in to fix grammer, content, information in any section of any guide. At that time we make checks for relevant cross references to- and from- for the section and then make them.

        Show
        kzeller kzeller added a comment - Fixed this instance in 1.8 and 2.0: https://github.com/couchbase/docs/commit/dc7d7bcf04238a932aa2abbd92243dd6a65ee6eb https://github.com/couchbase/docs/commit/c170b7dbbf65321ef1b4d4721cf63448e0c164c5 Closing this general ticket on improving cross references. This is an ongoing maintenance activity whenever a ticket comes in to fix grammer, content, information in any section of any guide. At that time we make checks for relevant cross references to- and from- for the section and then make them.

          People

          • Assignee:
            kzeller kzeller
            Reporter:
            perry Perry Krug
          • Votes:
            0 Vote for this issue
            Watchers:
            4 Start watching this issue

            Dates

            • Created:
              Updated:
              Resolved:

              Gerrit Reviews

              There are no open Gerrit changes