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

Docs: NRU discussion in ejection thresholds confusing

    Details

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

      Description

      This page: http://www.couchbase.com/docs/couchbase-manual-2.0/couchbase-admin-cbepctl-ejection.html

      It's very confusing to have the middle of the page start talking about "infrequently used" items when there hasn't been any discussion about NRU or mention above that "infrequently used" items are preferred for ejection in some way.

      Can we please restructure this page so that it makes a bit more sense to a naive reader?

      And add a link to the other relevant NRU sections (such as this one: http://www.couchbase.com/docs/couchbase-manual-2.0/couchbase-admin-cbepctl-access-scanner.html)

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

        Activity

        Hide
        mccouch MC Brown (Inactive) added a comment -

        Karen wrote this documentation and should address the issue.

        Show
        mccouch MC Brown (Inactive) added a comment - Karen wrote this documentation and should address the issue.
        Hide
        kzeller kzeller added a comment -

        Also on admin tasks section:

        Thanks for cleaning this up, it looks better.

        I still think the main page (http://www.couchbase.com/docs/couchbase-manual-2.0/couchbase-admin-tasks-working-set-mgmt.html) is rather hard to read being a whole stream of text and not really laid out visually to help the reader...you know what I mean right?

        ------------

        I think it's important to have cross-links back and forth to relevant sections of documentation.

        For example, the main working set page points you correctly to the commands, yet if you landed on the commands page (http://www.couchbase.com/docs/couchbase-manual-2.0/couchbase-admin-cbepctl-ejection.html), there's no obvious way of getting back to the description of what they're referring to. Make sense?

        ------------
        I think this is were we had discussed using "bold" headers/paragraphs to the text is all on a page but the headers indicate a transition in subject between paragraphs. Right?

        TODO:

        -Cross link back from command line to Admin Tasks
        -Add info introducing concept of least frequently used in command line
        -Add bold breaks for concept transition in Admin Tasks section, if needed also in command line discussion.

        Show
        kzeller kzeller added a comment - Also on admin tasks section: Thanks for cleaning this up, it looks better. I still think the main page ( http://www.couchbase.com/docs/couchbase-manual-2.0/couchbase-admin-tasks-working-set-mgmt.html ) is rather hard to read being a whole stream of text and not really laid out visually to help the reader...you know what I mean right? ------------ I think it's important to have cross-links back and forth to relevant sections of documentation. For example, the main working set page points you correctly to the commands, yet if you landed on the commands page ( http://www.couchbase.com/docs/couchbase-manual-2.0/couchbase-admin-cbepctl-ejection.html ), there's no obvious way of getting back to the description of what they're referring to. Make sense? ------------ I think this is were we had discussed using "bold" headers/paragraphs to the text is all on a page but the headers indicate a transition in subject between paragraphs. Right? TODO: -Cross link back from command line to Admin Tasks -Add info introducing concept of least frequently used in command line -Add bold breaks for concept transition in Admin Tasks section, if needed also in command line discussion.
        Hide
        kzeller kzeller added a comment -
        Show
        kzeller kzeller added a comment - Fixes pushed here: https://github.com/couchbase/docs/commit/db42a24f9609da0dc2f091044a06ebe8e74d135a
        Hide
        kzeller kzeller added a comment -
        Show
        kzeller kzeller added a comment - Fixes pushed here: https://github.com/couchbase/docs/commit/db42a24f9609da0dc2f091044a06ebe8e74d135a

          People

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

            Dates

            • Created:
              Updated:
              Resolved:

              Gerrit Reviews

              There are no open Gerrit changes