-
Suggestion
-
Resolution: Fixed
-
None
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
- incorporates
-
- Closed
- is related to
-
- Closed
- relates to
-
CONFSERVER-10534 Fix documentation links in EAR/WAR README file
-
- Closed
-
-
- Closed
[CONFSERVER-10357] Update the Confluence installation and setup documentation
| Workflow | Original: JAC Suggestion Workflow 4 [ 3580630 ] | New: JAC Suggestion Workflow 3 [ 4337784 ] |
| Workflow | Original: JAC Suggestion Workflow 2 [ 3169658 ] | New: JAC Suggestion Workflow 4 [ 3580630 ] |
| Status | Original: RESOLVED [ 5 ] | New: Closed [ 6 ] |
| Link | New: This issue details CONFSERVER-10537 [ CONFSERVER-10537 ] |
| Link | New: This issue details CONFSERVER-10538 [ CONFSERVER-10538 ] |
| Link | New: This issue details CONFSERVER-11050 [ CONFSERVER-11050 ] |
| Workflow | Original: JAC Suggestion Workflow [ 3039334 ] | New: JAC Suggestion Workflow 2 [ 3169658 ] |
| Workflow | Original: Confluence Workflow - Public Facing v4 [ 2538730 ] | New: JAC Suggestion Workflow [ 3039334 ] |
| Workflow | Original: Confluence Workflow - Public Facing v3 [ 2281491 ] | New: Confluence Workflow - Public Facing v4 [ 2538730 ] |
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.
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.