Uploaded image for project: 'Confluence Data Center'
  1. Confluence Data Center
  2. CONFSERVER-10357

Update the Confluence installation and setup documentation

    XMLWordPrintable

Details

    • We collect Confluence feedback from various sources, and we evaluate what we've collected when planning our product roadmap. To understand how this piece of feedback will be reviewed, see our Implementation of New Features Policy.

    Description

      We need to dramatically improve the quality of our install and configuration documentation that is seen and used by our new customers.

      We did a great job with improving the templates for our release notes and I would love to see us take a similar approach to our core 'getting started' documentation (install guides, admin guides, etc.).

      Guidelines for the improvements are:

      • the pages need to be much more readable. They are currently laborious to read;
      • remove the comments (and factor of the useful ones in )
      • create easy to follow sections (numbered sections perhaps?)
      • create clear buttons to proceed to next phases of the documentation (look at the poor quality of the next links on the Confluence Installation Guide below the Standalone and EAR/WAR tables
      • encourage users to evaluate using the standalone version until they are satisfied with the product functionality
      • direct users to commonly performed tasks
        • setting the application as a service
        • setting up LDAP integration
      • we should consider having two install guides (one for simple evaluations, and another for production ready evaluations)
      • the setup and install guides should most likely be combined
      • moving to the next logical part of the documentation versus moving to a potentially related area (as denoted by the Other Topics and Related Topics headings) should be represented as clearly different types of paths
      • the Security Warning seems over the top and serves to cause confusion and hassle more than any practical value (http://confluence.atlassian.com/display/DOC/Confluence+Setup+Guide)
      • use more screenshots and visuals, especially when discussing retrieving license keys
      • the process to retrieve evaluation keys has changed, this needs to be updated on relevant pages e.g. http://confluence.atlassian.com/display/DOC/Standard+Installation
      • some pages seem to be very short. It would perhaps be wiser to have longer pages that require less page loading and clicking e.g. http://confluence.atlassian.com/display/DOC/Standard+Installation

      Attachments

        Issue Links

          Activity

            People

              smaddox SarahA
              ben@atlassian.com BenjaminA
              Votes:
              1 Vote for this issue
              Watchers:
              2 Start watching this issue

              Dates

                Created:
                Updated:
                Resolved: