@@ -11,35 +11,34 @@ a GitHub event to [@carlbennett](https://github.com/carlbennett)'s [Jenkins
1111server] ( https://jenkins.carlbennett.me/ ) , which will build and deploy the code
1212to production.
1313
14- ## GitHub Code of Conduct
15- ### Feature requests / enhancements
16- All feature requests for the website must be vetted by one of the maintainers.
17- The maintainer will decide whether or not your request is valid and will also
18- either approve or deny your request. If approved, someone will integrate your
19- feature/ enhancement into the project when possible and when time permits.
14+ ## Code of Conduct
15+ ### Feature requests
16+ All feature requests for the project must be vetted by one of the maintainers.
17+ The maintainer will decide whether or not a request is valid and will also
18+ either approve or deny a request. If approved, someone will integrate the
19+ feature or enhancement into the project when possible and when time permits.
2020
2121### Issues
22- If you have found a bug or issue with the project/website, don't hesitate to
23- let us know. We accept all bug reports and will handle them in a respectful
24- manner.
22+ If an issue or bug is found with the project, do not hesitate to let the
23+ maintainers know. All bug reports are welcome and will be handled in a
24+ respectful manner.
2525
2626#### Submitting an issue
27- When you are submitting an issue, make sure you include the following:
27+ When submitting an issue, make sure to include the following:
2828
29- - A screenshot of the issue you're describing .
30- - Steps to reproduce the issue.
31- - How you encountered the issue.
32- - What your intention was and what you expected to happen.
33- - If you feel it necessary, or if asked for, details about your environment.
34- - Your operating system and its version number (e.g. Windows 7 Pro 64-bit).
35- - Your browser and its version number (e.g. Chrome 50).
29+ * A screenshot of the issue.
30+ * Steps to reproduce the issue.
31+ * How the issue was encountered .
32+ * What the intention was and what was expected to happen.
33+ * Details about the environment:
34+ * The operating system and its version number (e.g. Windows 7 Pro 64-bit).
35+ * The web browser and its version number (e.g. Chrome 50).
3636
37- Giving us the information above will help immensely when troubleshooting your
38- issue on our side, and could even lead directly to a bugfix in the best
39- scenario.
37+ Giving the information above will help immensely when troubleshooting the issue,
38+ and could even lead directly to a code change in the best scenario.
4039
4140## Project directory structure
42- The project is structured such that we can add tools, sample configurations,
41+ The project is structured such that it can support tools, sample configurations,
4342documentation, and of course the actual code, all in the same repository.
4443
4544| Path | Description |
@@ -53,31 +52,33 @@ documentation, and of course the actual code, all in the same repository.
5352Any file in the root of this repository is used by Git, GitHub, or otherwise
5453serves a very specific purpose such as licensing and the read me.
5554
56- ## How to create your development environment
57- The subsections here are more like a guide than an exact step by step. Use your
55+ ## How to create a development environment
56+ The subsections here are a general guide, not an exact step by step. Use your
5857own expertise and follow along. You may alter where you see fit for your own
59- preferences.
58+ preferences. If a different environment is preferred, go ahead, but these steps
59+ will need to be adapted and that will be on you to do.
6060
6161### VirtualBox
62- You'll need to procure Oracle VirtualBox or other virtualization software
62+ The environment requires Oracle VirtualBox or other virtualization software
6363that is capable of running ** CentOS 7 x86\_ 64** .
6464
65- - [ VirtualBox] ( https://www.virtualbox.org/ )
65+ * [ VirtualBox] ( https://www.virtualbox.org/ )
6666
6767### OS
68- Using your virtualization software, create an instance using the latest CentOS 7
69- x86\_ 64 iso image, and install the minimal operating system.
68+ Using the virtualization software, create a virtual machine instance using the
69+ latest CentOS 7 x86\_ 64 iso image, and install the minimal operating system.
7070
71- Other details are not important, tune it however you like.
71+ Details of the OS install are not important at this point in time, tune the OS
72+ however is preferred.
7273
7374### Post-Install
74- You'll need to install additional software to run this project.
75+ The following software will need to be installed to run this project:
7576
76- - [ Nginx] ( https://www.nginx.com/resources/wiki/start/topics/tutorials/install/ )
77- - [ Remi's PHP 7.2 repository] ( https://blog.remirepo.net/post/2017/12/04/Install-PHP-7.2-on-CentOS-RHEL-or-Fedora )
78- - [ MariaDB] ( https://mariadb.com/kb/en/library/yum/ )
79- - [ Composer] ( https://getcomposer.org/ )
80- - Memcached
77+ * [ Nginx] ( https://www.nginx.com/resources/wiki/start/topics/tutorials/install/ )
78+ * [ Remi's PHP 7.2 repository] ( https://blog.remirepo.net/post/2017/12/04/Install-PHP-7.2-on-CentOS-RHEL-or-Fedora )
79+ * [ MariaDB] ( https://mariadb.com/kb/en/library/yum/ )
80+ * [ Composer] ( https://getcomposer.org/ )
81+ * Memcached
8182
8283PHP should be capable of retrieving geoip information, generating gmp values,
8384encoding and decoding json, accessing mysql with PDO, and able to manage a
@@ -86,10 +87,10 @@ list of required extensions is in the `/composer.json` file in the root of this
8687repository.
8788
8889### Configuring
89- Configure these such that nginx is a fastcgi proxy to php-fpm. You'll then run
90+ Configure nginx so that it is a fastcgi proxy to php-fpm. You will then run
9091` composer install ` to get additional vendor files required for this project.
9192
92- You should point nginx/php-fpm at the ` /main.php ` file for all requests.
93+ Nginx should be pointed at the ` /main.php ` file for all requests.
9394
9495MariaDB should be configured with the ` TRADITIONAL,NO_AUTO_VALUE_ON_ZERO ` modes.
9596A sample configuration can be found at ` etc/mysql-server.sample.cnf ` . MariaDB
@@ -105,5 +106,5 @@ The PHP date timezone should be in UTC, though the code will configure PHP for
105106this on its own.
106107
107108The ` etc/config.sample.json ` should be copied to ` etc/config.phoenix.json ` and
108- modified for your environment settings. It will need at the very least the
109+ modified for the environment settings. It will need at the very least the
109110settings for MariaDB and Memcached.
0 commit comments