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

Admin Guide refresh and rationalization

    XMLWordPrintable

Details

    • Enhancement
    • Resolution: Unresolved
    • Major
    • None
    • None
    • Documentation, Management
    • None
    • ---
    • ---

    Description

      The Admin Guide is showing its age a bit, one way being that it has been modified somewhat ad-hoc over time, with the result that it kind of rambles.

      Things I'd like to see done (which will likely involve separate issues with this one acting as a kind of epic):

      1) After section 2 "Core Management Concepts" add a section about "Starting WildFly". Move the command line param stuff (https://docs.wildfly.org/30/Admin_Guide#Command_line_parameters) there.

      2) In that section also include stuff about controlling JVM settings from the command line (not including domain mode specific server JVM stuff.)

      3) Move 'Domain Setup' (https://docs.wildfly.org/30/Admin_Guide#Domain_Setup) before 'Application Deployment' (https://docs.wildfly.org/30/Admin_Guide#application-deployment) Perhaps find a somewhat different name.

      4) Move 'Management Task' content that is domain specific to 'Domain Setup':

      Starting/stopping servers – https://docs.wildfly.org/30/Admin_Guide#Starting_and_Stopping_Servers_in_a_Managed_Domain

      JVM Settings – https://docs.wildfly.org/30/Admin_Guide#JVM_settings

      5) Consider adding a brief section to 'Domain Setup' that links to domain mode discussions in other areas of the doc where it makes more sense for domain to be an aspect of that section's discussion

      6) DONE Review 'Subsystem Configuration' to try and come up with a more logical order for sections. Right now it is random.

      7) Rework 'Management Clients'. It has evolved in an uncomfortable way, where there's a mixing of the concept of 'web console' with 'http management interface'. And then 'native interface' is also used. With security mixed in the middle. This should be rationalized. (Also, perhaps old stuff about using curl etc should be restored somewhere, perhaps in 'Management Tasks'.)

      8) Consider renaming 'Management Tasks' to something more descriptive in the TOC. It's accurate now, just vague. It's kind of a grab-bag is misc stuff, which is ok, such a thing seems needed.

      9) Link to 'CLI Recipes' from the CLI section in 'Management Clients'.

      10) Do some copy-editing on 'CLI Recipes'.

      11) DONE Move 'Management API Reference' last.

      12) Add a brief "Installing WildFly" or "Getting Started" section after 'Target Audience' that basically links to the other documents on this topic. Provide an easy path to this content for readers who start with this guide.

      13) 'Subsystem configuration' subsection improvements (which is an epic of its own).

      The resulting top level TOC becomes:

      1) Target Audience
      2) Getting Started
      3) Core Management Concepts
      4) Starting WildFly (now that you understand standalone vs domain, feature stability etc)
      5) Management Clients (more useful now that you've started!)
      6) Administrative Security (get this right before mucking around further)
      7) Domain Setup (more foundational knowledge)
      8) Application Deployment
      9) Subsystem Configuration
      10) Management Tasks (misc stuff)
      11 ) CLI Recipes (similar to Management Tasks, so right after)
      12) Managment API Reference

      Attachments

        Issue Links

          Activity

            People

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

              Dates

                Created:
                Updated: