Uploaded image for project: 'WildFly'
  1. WildFly
  2. WFLY-9744

Improve Infinispan subsystem model descriptions

    XMLWordPrintable

Details

    • Task
    • Resolution: Unresolved
    • Major
    • None
    • None
    • Clustering
    • None

    Description

      In order to not duplicate documentation in docs/ and wildscribe, we will link from documentation to wildscribe. This requires descriptions to be improved. The descriptions:

      • should describe behavior
      • should avoid using domain model terminology (e.g. attributes, child)
      • take out the redundant verb such as 'configures' (unless appropriate, e.g. in operation desc.)
      • remove unnecessary "Deprecated." notices, the information is already in the model, e.g.:
        "deprecated" => {
            "since" => "5.0.0",
            "reason" => "Deprecated. Consider using a shared store instead, where writes are only performed by primary owners."
        },
        

      Upon completion, we can remove the sections from documentation and link.

      Attachments

        Issue Links

          Activity

            People

              pferraro@redhat.com Paul Ferraro
              rhn-engineering-rhusar Radoslav Husar
              Votes:
              0 Vote for this issue
              Watchers:
              1 Start watching this issue

              Dates

                Created:
                Updated: