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

Admin Guide 'Subsystem configuration' subsection improvements

XMLWordPrintable

    • Icon: Enhancement Enhancement
    • Resolution: Unresolved
    • Icon: Major Major
    • None
    • None
    • Documentation
    • None
    • ---
    • ---

      Item #13 under WFLY-18945.

      Aim for greater consistency in the sections in the Admin Guide 'Subsystem Configuration' section. Things like:

      1) Common approach to the initial abstract.
      a) Use the asciidoc 'abstract' tag consistently (perhaps not at all).
      b) Consistent handling of the formal name of the subsystem vs its general description (e.g. 'jaxrs' subsystem vs Jakarta RESTful Web Services subsytem.) Using both is fine; there should just be a fairly consistent way of introducing the formal name. Including formatting of the formal name using backticks.

      2) A consistently located and expressed section on how to 'provision' the subsystem, via CLI or galleon-based tooling. Many newer subsystems have this; older ones do not.

      3) Early on, a link to the wildscribe content for the subsystem.

      4) Limited or removed of discussion of specific API versions or xml schemas. These things inevitably get out of date. It's ok to note that an example using a particular schema, but don't act like that version is 'the version' as it may soon be well out of date.

      5) Other things we may identify as we start working for consistency – how to present commonly needed things in a consistent way.

      Some subsystems may need major work unrelated to this 'consistency' theme, but that is out-of-scope for this JIRA.

            Unassigned Unassigned
            bstansbe@redhat.com Brian Stansberry
            Votes:
            0 Vote for this issue
            Watchers:
            1 Start watching this issue

              Created:
              Updated: