Checkbook icon indicating copy to clipboard operation
Checkbook copied to clipboard

Documentation fixes - how to proceed?

Open ecs-hk opened this issue 9 years ago • 5 comments

After deploying Checkbook NYC repeatedly over the last few days (on Amazon EC2 and RDS), I have found a number of issues in the current INSTALL.md and SOLR-INSTALL.md.

Show stoppers

Some of the documentation issues are complete show stoppers. For instance, this one:

$ sudo su www-data $ cp -a source/webapp/* /var/www/html

Following these steps will result in a Drupal installation that doesn't work at all. The /* shell glob does not capture dotfiles (e.g. .htaccess), so the URI rewrites will not work properly.

Security suggestions

Other documentation issues are simply suggested changes for improved security. In my internal notes, I've modified the steps to create a service account for Apache Tomcat, and run it with the unprivileged account. Similarly, the Drupal files are root-owned and read-only (with a handful of exceptions) by the Apache HTTP Server service account.

Question

I'd like to submit a pull request to make various documentation changes. Is it OK if I bundle it all up as a single pull request? Or is it cleaner to first fix "show stopper" problems and then a second pull request for "security suggestions"?

ecs-hk avatar Dec 28 '15 06:12 ecs-hk