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

Update the Confluence installation and setup documentation

    • 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.

      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

            [CONFSERVER-10357] Update the Confluence installation and setup documentation

            Greetings,

            We spent hours attempting to figure out how to install Confluence on Ubuntu 16.04 with MySql 5.6 and solve warnings on the InnoDB Log File Size health check has failed in your system and The Max Allowed Packet health check has failed in your system.  We should tell users to carefully check my.cnf and confirm values with:

            mysql -uroot -p

            show variables;

            If my.cnf is not working use:

            sudo locate my.cnf  to locate my.cnf file.

            sudo /sbin/service mysqld stop
            Rename and move the logfiles:

            sudo ls -l /var/lib/mysql/ will confirm location and size
            sudo mv /var/lib/mysql/ib_logfile0 /tmp/ib_logfile0.bak
            sudo mv /var/lib/mysql/ib_logfile1 /tmp/ib_logfile1.bak

            sudo mv /etc/mysql/my.cnf /etc/mysql/my.cnf.backup

            sudo cp /usr/share/doc/mysql-server-5.6/examples/my-default.cnf /etc/mysql/my.cnf

            nano /etc/mysql/my.cnf to set settings and remove comments at beginning of file.

            Perform steps to rebuild innodb log file safely.

            Restart Service
            /sbin/service mysqld start

            sudo ls -l /var/lib/mysql/ will confirm location

            Also provide better instructions on creating database, understanding the user confluence needs ownership of files, how to restart database setup when errors occur, how to place .jar database files in proper folders with proper permissions.  I finally had to place commands in web.xml and use Tomcat connection information to get my server to work.

            WSS Support added a comment - Greetings, We spent hours attempting to figure out how to install Confluence on Ubuntu 16.04 with MySql 5.6 and solve warnings on the InnoDB Log File Size health check has failed in your system and The Max Allowed Packet health check has failed in your system.  We should tell users to carefully check my.cnf and confirm values with: mysql -uroot -p show variables; If my.cnf is not working use: sudo locate my.cnf  to locate my.cnf file. sudo /sbin/service mysqld stop Rename and move the logfiles: sudo ls -l /var/lib/mysql/ will confirm location and size sudo mv /var/lib/mysql/ib_logfile0 /tmp/ib_logfile0.bak sudo mv /var/lib/mysql/ib_logfile1 /tmp/ib_logfile1.bak sudo mv /etc/mysql/my.cnf /etc/mysql/my.cnf.backup sudo cp /usr/share/doc/mysql-server-5.6/examples/my-default.cnf /etc/mysql/my.cnf nano /etc/mysql/my.cnf to set settings and remove comments at beginning of file. Perform steps to rebuild innodb log file safely. Restart Service /sbin/service mysqld start sudo ls -l /var/lib/mysql/ will confirm location Also provide better instructions on creating database, understanding the user confluence needs ownership of files, how to restart database setup when errors occur, how to place .jar database files in proper folders with proper permissions.  I finally had to place commands in web.xml and use Tomcat connection information to get my server to work.

            Greetings,

            We spent hours attempting to figure out how to install Confluence on Ubuntu 16.04 with MySql 5.6 and solve warnings on the InnoDB Log File Size health check has failed in your system and The Max Allowed Packet health check has failed in your system.  We should tell users to carefully check my.cnf and confirm values with:

            mysql -uroot -p

            show variables;

            If my.cnf is not working use:

            sudo locate my.cnf  to locate my.cnf file.

            sudo /sbin/service mysqld stop
            Rename and move the logfiles:

            sudo ls -l /var/lib/mysql/ will confirm location and size
            sudo mv /var/lib/mysql/ib_logfile0 /tmp/ib_logfile0.bak
            sudo mv /var/lib/mysql/ib_logfile1 /tmp/ib_logfile1.bak

            sudo mv /etc/mysql/my.cnf /etc/mysql/my.cnf.backup

            sudo cp /usr/share/doc/mysql-server-5.6/examples/my-default.cnf /etc/mysql/my.cnf

            nano /etc/mysql/my.cnf to set settings and remove comments at beginning of file.

            Perform steps to rebuild innodb log file safely.

            Restart Service
            /sbin/service mysqld start

            sudo ls -l /var/lib/mysql/ will confirm location

            Also provide better instructions on creating database, understanding the user confluence needs ownership of files, how to restart database setup when errors occur, how to place .jar database files in proper folders with proper permissions.  I finally had to place commands in web.xml and use Tomcat connection information to get my server to work.

            WSS Support added a comment - Greetings, We spent hours attempting to figure out how to install Confluence on Ubuntu 16.04 with MySql 5.6 and solve warnings on the InnoDB Log File Size health check has failed in your system and The Max Allowed Packet health check has failed in your system.  We should tell users to carefully check my.cnf and confirm values with: mysql -uroot -p show variables; If my.cnf is not working use: sudo locate my.cnf  to locate my.cnf file. sudo /sbin/service mysqld stop Rename and move the logfiles: sudo ls -l /var/lib/mysql/ will confirm location and size sudo mv /var/lib/mysql/ib_logfile0 /tmp/ib_logfile0.bak sudo mv /var/lib/mysql/ib_logfile1 /tmp/ib_logfile1.bak sudo mv /etc/mysql/my.cnf /etc/mysql/my.cnf.backup sudo cp /usr/share/doc/mysql-server-5.6/examples/my-default.cnf /etc/mysql/my.cnf nano /etc/mysql/my.cnf to set settings and remove comments at beginning of file. Perform steps to rebuild innodb log file safely. Restart Service /sbin/service mysqld start sudo ls -l /var/lib/mysql/ will confirm location Also provide better instructions on creating database, understanding the user confluence needs ownership of files, how to restart database setup when errors occur, how to place .jar database files in proper folders with proper permissions.  I finally had to place commands in web.xml and use Tomcat connection information to get my server to work.

            SarahA added a comment -

            I'm closing this issue now, and handing its completion over to the Confluence 2.8 tracking. See parent issue http://jira.atlassian.com/browse/CONF-9506 plus its subtasks.

            SarahA added a comment - I'm closing this issue now, and handing its completion over to the Confluence 2.8 tracking. See parent issue http://jira.atlassian.com/browse/CONF-9506 plus its subtasks.

            SarahA added a comment - Upgrade guides now also extensively updated. Not yet published - awaiting review and then the launch of Confluence 2.8: http://confluence.atlassian.com/display/DOC/Preparing+to+Upgrade+Confluence http://confluence.atlassian.com/display/DOC/Reapplying+Customisations+after+Confluence+Upgrade http://confluence.atlassian.com/display/DOC/Troubleshooting+the+Confluence+Upgrade http://confluence.atlassian.com/display/DOC/Copy+of+Upgrading+Confluence http://confluence.atlassian.com/display/DOC/Upgrading+Confluence+Standalone+Edition http://confluence.atlassian.com/display/DOC/Upgrading+Confluence+EAR-WAR+Edition Requests for review are here: http://jira.atlassian.com/browse/CONF-11130 http://jira.atlassian.com/browse/CONF-11129

            SarahA added a comment -

            EAR-WAR guide is complete and published.

            SarahA added a comment - EAR-WAR guide is complete and published.

            SarahA added a comment -

            EAR-WAR guide substantially rewritten.
            Sent to developer for review — http://jira.atlassian.com/browse/CONF-11050

            SarahA added a comment - EAR-WAR guide substantially rewritten. Sent to developer for review — http://jira.atlassian.com/browse/CONF-11050

            BenjaminA added a comment -

            Excellent work Sarah!

            B

            BenjaminA added a comment - Excellent work Sarah! B

            SarahA added a comment - New and extensively-revised installation docs for Confluence 2.8: http://confluence.atlassian.com/display/DOC/Copy+of+Confluence+Installation+Guide http://confluence.atlassian.com/display/DOC/System+Requirements http://confluence.atlassian.com/display/DOC/Copy+of+Installing+Confluence+Standalone http://confluence.atlassian.com/display/DOC/Uninstalling+Confluence+Standalone http://confluence.atlassian.com/display/DOC/Installing+Confluence+Standalone+on+Windows+from+Zip+File http://confluence.atlassian.com/display/DOC/Installing+Confluence+Standalone+on+a+Mac+from+Zip+File http://confluence.atlassian.com/display/DOC/Installing+Confluence+Standalone+on+Unix The following docs are also relevant but content is excerpt-included in the above pages: http://confluence.atlassian.com/display/DOC/Confluence+Unix+and+X11+Dependencies http://confluence.atlassian.com/display/DOC/Installing+the+JDK http://confluence.atlassian.com/display/DOC/Change+listen+port+for+Confluence+Standalone Note: All docs are currently hidden from public view. All docs are currently undergoing tech writer review and developer review. Background is in the following issues: CONF-10762 CONF-9506 CONF-11047 CONF-11048 Still to do: EAR/WAR guide

            BenjaminA added a comment -

            Thanks!

            B

            BenjaminA added a comment - Thanks! B

            SarahA added a comment -

            Done

            SarahA added a comment - Done

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

                Created:
                Updated:
                Resolved: