Skip to content

Commit 5b98e08

Browse files
committed
Linkify parts of this guide
1 parent 0843b27 commit 5b98e08

File tree

1 file changed

+11
-7
lines changed

1 file changed

+11
-7
lines changed

CONTRIBUTING.md

Lines changed: 11 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -83,28 +83,32 @@ The following software will need to be installed to run this project:
8383
PHP should be capable of retrieving geoip information, generating gmp values,
8484
encoding and decoding json, accessing mysql with PDO, and able to manage a
8585
Memcached store. Aside from that, it also needs the pecl http library. The full
86-
list of required extensions is in the `/composer.json` file in the root of this
87-
repository.
86+
list of required extensions is in the [composer.json](./composer.json) file.
8887

8988
### Configuring
9089
Configure nginx so that it is a fastcgi proxy to php-fpm. You will then run
9190
`composer install` to get additional vendor files required for this project.
9291

93-
Nginx should be pointed at the `/main.php` file for all requests.
92+
Nginx should be pointed at the [src/main.php](./src/main.php) file for all
93+
requests.
9494

9595
MariaDB should be configured with the `TRADITIONAL,NO_AUTO_VALUE_ON_ZERO` modes.
96-
A sample configuration can be found at `etc/mysql-server.sample.cnf`. MariaDB
97-
data can be seeded by importing the contents of `/etc/database.sample.sql`.
96+
A sample configuration can be found at
97+
[etc/mysql-server.sample.cnf](./etc/mysql-server.sample.cnf). MariaDB data can
98+
be seeded by importing the contents of
99+
[etc/database.sample.sql](./etc/database.sample.sql).
98100

99101
Memcached does not require extra configuration from its package defaults, but
100-
a sample configuration is available at `etc/memcached.sample.conf`. Memcached
102+
a sample configuration is available at
103+
[etc/memcached.sample.conf](./etc/memcached.sample.conf). Memcached
101104
settings typically are saved to `/etc/sysconfig/memcached` and increasing the
102105
memory Memcached can use is typically recommended but not required for a
103106
development environment.
104107

105108
The PHP date timezone should be in UTC, though the code will configure PHP for
106109
this on its own.
107110

108-
The `etc/config.sample.json` should be copied to `etc/config.phoenix.json` and
111+
The [etc/config.sample.json](./etc/config.sample.json) should be copied to
112+
[etc/config.phoenix.json](./etc/config.phoenix.json) and
109113
modified for the environment settings. It will need at the very least the
110114
settings for MariaDB and Memcached.

0 commit comments

Comments
 (0)