From ecc17e21d8a3fdb1282f86a9b1ae2f31e6f07585 Mon Sep 17 00:00:00 2001 From: goldquest Date: Tue, 11 Apr 2017 16:27:25 +0200 Subject: [PATCH 1/2] Installation proof-read --- _includes/docs/install/aws-user-data.md | 6 ++--- _includes/docs/install/installation.md | 24 ++++++++--------- _includes/docs/install/post-installation.md | 2 +- .../docs/install/reqs/req-configuration.md | 18 ++++++------- _includes/docs/install/reqs/req-lamp.md | 26 +++++++++---------- .../docs/install/reqs/req-operating-system.md | 6 ++--- 6 files changed, 41 insertions(+), 41 deletions(-) diff --git a/_includes/docs/install/aws-user-data.md b/_includes/docs/install/aws-user-data.md index c484000..9788fbe 100644 --- a/_includes/docs/install/aws-user-data.md +++ b/_includes/docs/install/aws-user-data.md @@ -1,5 +1,5 @@ -Here is one example for setup of AWS EC2 Ubuntu 16.04 instance. Script provided here can be copy/pasted in User Data during creation of EC2 instance and it will execute and create everything for you. -After Instance is up and running, it's sufficient just to open the site in the browser and start with the installation process. +Here is one example for a setup of an AWS EC2 Ubuntu 16.04 instance. The script provided here can be copy/pasted in User Data during creation of EC2 instance and it will execute and create everything for you. +After Instance is up and running, it's sufficient to just open the site in the browser and start with the installation process. There are only three parameters that should be adjusted: ```MYSQL_ROOT_PASSWORD```, ```MYSQL_THUNDER_PASSWORD``` and ```SITE_DOMAIN```. ``` @@ -95,7 +95,7 @@ su - -c "composer global require drush/drush && echo 'PATH=\"\$HOME/.composer/ve su - -c "composer create-project burdamagazinorg/thunder-project ~/www --no-interaction --quiet" thunder # Add Virtual Host to Apache -# Add Virtual Host for +# Add Virtual Host for cat <> /etc/apache2/sites-available/$SITE_DOMAIN.conf diff --git a/_includes/docs/install/installation.md b/_includes/docs/install/installation.md index 3158716..e74f182 100644 --- a/_includes/docs/install/installation.md +++ b/_includes/docs/install/installation.md @@ -1,29 +1,29 @@ -We will use thunder project scaffold for installing thunder distribution. +We will use the thunder project scaffold for installing the thunder distribution. -You can create Thunder project with the following command: +You can create a Thunder project with the following command: ``` # composer create-project burdamagazinorg/thunder-project ~/www ``` -That will create ```www``` folder in the home directory of thunder user and that will be the directory for the site. +That will create a ```www``` folder in the home directory of the thunder user, which will be the directory for the site. -Also, all required libraries and modules will be fetched and it will also create "docroot" directory. -That directory will be used as docroot directory for site and it has to be added in Apache configuration for site. +Also, all required libraries and modules will be fetched and it will also create a "docroot" directory. +That directory will be used as docroot directory for the site and it has to be added in the Apache configuration for the site. -We will create new Apache configuration for site. As a starting point, we will use existing default configuration provided with Apache installation. To do that execute following commands: +We will create a new Apache configuration for the site. As a starting point, we will use an existing default configuration provided with the Apache installation. To do that, execute following commands: ``` # sudo cp /etc/apache2/sites-available/000-default.conf /etc/apache2/sites-available/thunder-install-docs.conf # sudo ln -s /etc/apache2/sites-available/thunder-install-docs.conf /etc/apache2/sites-enabled/thunder-install-docs.conf ``` -Now configuration adjustment is required. You can open configuration file with your favorite editor (vi, nano, etc.). -Ensure that you need root rights for that. In this documentation, we will use most common editor ```vi```. +Now configuration adjustments are required. You can open the configuration file with your favorite editor (vi, nano, etc.). +Ensure that you need root rights for that. In this documentation, we will use the common editor ```vi```. ``` # sudo vi /etc/apache2/sites-available/thunder-install-docs.conf ``` -You can edit configuration as it suits your system and need or you can use full configuration provided here: +You can edit the configuration as it suits your system and need or you can use the full configuration provided here: ``` ServerName thunder-install-docs.org @@ -45,13 +45,13 @@ You can edit configuration as it suits your system and need or you can use full # vim: syntax=apache ts=4 sw=4 sts=4 sr noet ``` -After configuration changes Apache restart is required: +After configuration changes, an Apache restart is required: ``` # sudo service apache2 restart ``` Now when you open your site page ```www.thunder-install-docs.org``` it should start the installation of Thunder. -For that process, you can take look at [Thunder installation video tutorial](https://youtu.be/7iNKJIMTcMI?t=125) provided on [ThunderCMS YouTube channel](https://www.youtube.com/channel/UCCHCG7B6EQG2wUeiOVLVzPA). One exception to the video tutorial is that you have to provide MySQL database name (thunder) and credentials that you have set at creation of MySQL user. +For that process, you can take look at [Thunder installation video tutorial](https://youtu.be/7iNKJIMTcMI?t=125) provided on [ThunderCMS YouTube channel](https://www.youtube.com/channel/UCCHCG7B6EQG2wUeiOVLVzPA). One exception to the video tutorial is that you have to provide MySQL database name (thunder) and credentials that you have set at the creation of the MySQL user. -After you have finished installation of Thunder, still few changes should be made. +After you have finished the installation of Thunder, still a few changes should be made. diff --git a/_includes/docs/install/post-installation.md b/_includes/docs/install/post-installation.md index ada2896..26e1585 100644 --- a/_includes/docs/install/post-installation.md +++ b/_includes/docs/install/post-installation.md @@ -10,4 +10,4 @@ You should change "settings.php" and "services.yml" access rights to read-only. #### Enable SSL In order to make your site more secure for your users, you should enable HTTPS access. As certificate authority, you can use [Let’s Encrypt](https://letsencrypt.org). -And one of simplest ways to use it on Ubuntu 16.04 is with [Certbot](https://certbot.eff.org). Certbot will handle renewal of certificates and it will also make modifications to your Apache configuration. +One of simplest ways to use it on Ubuntu 16.04 is with [Certbot](https://certbot.eff.org). Certbot will handle renewal of certificates and it will also make the necessary modifications to your Apache configuration. diff --git a/_includes/docs/install/reqs/req-configuration.md b/_includes/docs/install/reqs/req-configuration.md index 2b5ec6e..a6caf1b 100644 --- a/_includes/docs/install/reqs/req-configuration.md +++ b/_includes/docs/install/reqs/req-configuration.md @@ -1,12 +1,12 @@ #### Configure Apache server -We need to enable several modules required by Apache to fulfill all requirements for site. Execution of the following command should enable all required modules: +We need to enable several modules required by Apache to fulfill all requirements for the site. Execution of the following command should enable all required modules: ``` # sudo a2enmod rewrite ssl fastcgi proxy_fcgi ``` -After that ```php-fpm``` configuration should be enabled for Apache and restart of ```apache2``` service has to be made in order to apply of configuration changes for it. +After that ```php-fpm``` configuration should be enabled for Apache and a restart of ```apache2``` service has to be made in order to apply of configuration changes for it. ``` # sudo a2enconf php7.0-fpm # sudo service apache2 restart @@ -14,7 +14,7 @@ After that ```php-fpm``` configuration should be enabled for Apache and restart #### Configure MySQL database -Start MySQL client to execute SQL statements required for installation of Thunder. +Start MySQL client to execute SQL statements required for the installation of Thunder. ``` # sudo mysql -u root -p @@ -26,26 +26,26 @@ Following SQL statement should be executed to create a database that will be use mysql> CREATE DATABASE thunder; ``` -For next command you have to specify a password for your user, so replace ```[PASSWORD]``` with the password you want: +For the next command you have to specify a password for your user, so replace ```[PASSWORD]``` with the password you want: ``` mysql> CREATE USER 'thunder'@'localhost' IDENTIFIED BY '[PASSWORD]'; ``` -To grant all access rights required for proper site functioning, following statement should be executed. +To grant all access rights required for a proper functioning site, following statement should be executed. ``` mysql> GRANT SELECT, INSERT, UPDATE, DELETE, CREATE, DROP, INDEX, ALTER, CREATE TEMPORARY TABLES ON thunder.* TO 'thunder'@'localhost'; ``` -Since all required configuration is finished, you can exit MySQL client by typing ```exit```. With that MySQL database configuration requirements are changed. +Since all required configuration changes are done, you can exit MySQL client by typing ```exit```. With that MySQL database configuration requirements are changed. #### Configure PHP -It would be also nice to additionally tweak OPcache configuration for PHP FPM service. You should open OPcache configuration file: +It would also be nice to additionally tweak OPcache configuration for PHP FPM service. You should open OPcache configuration file: ``` # sudo vi /etc/php/7.0/fpm/conf.d/10-opcache.ini ``` -And add following configuration at end of it: +And add following configuration at the end of it: ``` opcache.enable=1 opcache.memory_consumption=128 @@ -58,4 +58,4 @@ opcache.fast_shutdown=1 After all configuration changes are done for PHP FPM service, we should restart ```php7.0-fpm``` service: ``` # sudo service php7.0-fpm restart -``` \ No newline at end of file +``` diff --git a/_includes/docs/install/reqs/req-lamp.md b/_includes/docs/install/reqs/req-lamp.md index b21f622..6ae4b1a 100644 --- a/_includes/docs/install/reqs/req-lamp.md +++ b/_includes/docs/install/reqs/req-lamp.md @@ -8,7 +8,7 @@ First, available packages should be fetched with an execution of the following c #### 1. Web Server -We have used Apache2 server because it's widely used for Drupal sites and also Drupal provides some additional security features only for Apache. +We have used Apache2 server because it's widely used for Drupal sites and also Drupal provides some additional security features only for Apache. Apache can be installed with the following command: ``` @@ -24,8 +24,8 @@ Since MySQL is most known and widely used database, it will be used also in this # sudo apt-get install mysql-server mysql-client -y ``` -The installation process will require from user to type-in password for database root user. It's suggested to set a strong password, -but also a connection to MySQL server should be limited only from localhost. +The installation process will require to type-in the password for the database root user. It's suggested to set a strong password, +but also a connection to the MySQL server should be limited only from localhost. To ensure that MySQL server is properly secured it's advised to execute following command and follow instructions: ``` @@ -35,7 +35,7 @@ To ensure that MySQL server is properly secured it's advised to execute followin #### 3. PHP with required libraries Next step is to install PHP with all required libraries. -Since we are using latest LTS release of Ubuntu, it comes with PHP 7.0 and that's also recommended PHP version for Thunder since it has a way better performance compared to older version of PHP (version 5.6). +Since we are using latest LTS release of Ubuntu, it comes with PHP 7.0 and that's also the recommended PHP version for Thunder since it has a way better performance compared to older version of PHP (version 5.6). To install PHP and all required libraries you can execute the following command: ``` @@ -44,10 +44,10 @@ To install PHP and all required libraries you can execute the following command: #### 4. Composer and NodeJS -The composer is used for downloading of project and installation of it. It's tool for dependency management in PHP. It allows you to declare project dependencies and it will manage (install/update) them. +Composer is used for downloading of project and installation of it. It's a tool for dependency management in PHP. It allows you to declare project dependencies and it will manage (install/update) them. -To install composer you can read [installation instructions here](https://getcomposer.org/download). -Composer executable will be fetched in the directory where installation process is executed, but it would be better to set it in the ```bin``` directory of the user, so that we have that command in the console. +To install Composer you can read [installation instructions here](https://getcomposer.org/download). +The Composer executable will be fetched in the directory where the installation process is executed, but it would be better to set it in the ```bin``` directory of the user, so that we have that command in the console. In order to do that, execute following commands: @@ -63,7 +63,7 @@ You can verify that by executing: # composer list ``` -Additional requirements are NodeJS and ```npm``` command. It's needed for deploying of several JavaScript libraries used by Thunder to correct place. +Additional requirements are NodeJS and ```npm``` command. It's needed for deploying several JavaScript libraries used by Thunder to the correct place. The ```bower``` is used for that. To install NodeJS on your system, following command can be executed: ``` @@ -72,7 +72,7 @@ The ```bower``` is used for that. To install NodeJS on your system, following co #### 5. Git -It's common for Linux operating systems to came with ```git``` already installed. You can verify it with executing the following command: +It's common for Linux operating systems to come with ```git``` already installed. You can verify it with executing the following command: ``` # git --version @@ -86,14 +86,14 @@ If the ```git``` command is not available you can install it by executing the fo #### 6. Drush (optional) -We also recommend installing the ```drush``` command globally for your user, since this command is used for manipulation of Drupal projects and it has very handy tools. +We also recommend installing the ```drush``` command globally for your user, since this command is used for manipulation of Drupal projects and it has very handy tools. -Since composer is available on the system, installation of drush command globally for the user can be easily done. With following command you will install drush command: +Since Composer is available on the system, installation of drush command globally for the user can easily be done. With following command you will install drush command: ``` # composer global require drush/drush ``` -To make all globally installed composer commands available in the console, a path to global composer bin directory has to be added into PATH environment variable. +To make all globally installed composer commands available in the console, a path to global composer bin directory has to be added into the PATH environment variable. You can achieve that with the following command: ``` # export PATH="$HOME/.composer/vendor/bin:$PATH" @@ -112,7 +112,7 @@ To ensure drush command works as expected in the console you can execute the fol #### 7. Sendmail (optional) -Your site should be able to send e-mails. In order to do that SMTP server is required. Most common SMTP server on Linux based operating systems is ```sendmail```. +Your site should be able to send e-mails. In order to do that, an SMTP server is required. The most common SMTP server on Linux based operating systems is ```sendmail```. To install it, following commands should be executed and instructions followed: ``` diff --git a/_includes/docs/install/reqs/req-operating-system.md b/_includes/docs/install/reqs/req-operating-system.md index aa1eb84..0978197 100644 --- a/_includes/docs/install/reqs/req-operating-system.md +++ b/_includes/docs/install/reqs/req-operating-system.md @@ -7,15 +7,15 @@ #### Creating new user with sudo rights -By default you get logged as ```ubuntu``` user and that user has sudo rights. -To create new user ```thunder``` execute following commands: +By default you get logged in as ```ubuntu``` user and that user has sudo rights. +To create a new ```thunder``` user, execute following commands: ``` # sudo adduser thunder # sudo usermod -aG sudo thunder ``` -After that, you can log as ```thunder``` user and continue with next steps of the installation process. +After that, you can log in as ```thunder``` user and continue with the next steps of the installation process. ``` # sudo su - thunder From 23f354cc3d584b1539bc706665b8b5d90bc79540 Mon Sep 17 00:00:00 2001 From: goldquest Date: Tue, 11 Apr 2017 16:41:22 +0200 Subject: [PATCH 2/2] Remove already added documentation --- index.md | 9 +++------ 1 file changed, 3 insertions(+), 6 deletions(-) diff --git a/index.md b/index.md index 4594311..45a4621 100644 --- a/index.md +++ b/index.md @@ -64,7 +64,7 @@ permalink: / 6. Update 7. Adding Fields -## Technical Documentation +## Technical Documentation TODO 1. DevOps 1. Environment Setup -> Pre-requirements? 2. Varnish @@ -72,11 +72,8 @@ permalink: / 4. Database config 5. Search Engines 2. Installation & Updating - 1. Pre-requirements - 1. PHP config - 2. MySQL config - 2. Installation instructions - 3. Config updates + 1. Installation instructions <-- migration needed + 2. Config updates 4. Under the Hood 1. How articles work 2. How media works