Commit 01b36c3
committed
A series of trivial changes to the main README.md
1 parent 84d6104 commit 01b36c3
1 file changed
Lines changed: 20 additions & 27 deletions
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
@@ -1,11 +1,11 @@ | |||
| 1 | 1 | We're hiring! | |
| 2 | 2 | -------- | |
| 3 | - Ever thought about joining us?<br/> | ||
| 3 | + Ever thought about joining us? | ||
| 4 | 4 | http://developers.theguardian.com/join-the-team.html | |
| 5 | 5 | ||
| 6 | 6 | Frontend | |
| 7 | 7 | ======== | |
| 8 | - The Guardian website frontend. | ||
| 8 | + [The Guardian](www.theguardian.com) website frontend. | ||
| 9 | 9 | ||
| 10 | 10 | Frontend is a set of Play Framework 2 Scala applications. | |
| 11 | 11 | ||
@@ -21,9 +21,7 @@ On the server | |||
| 21 | 21 | ------------- | |
| 22 | 22 | ||
| 23 | 23 | * Every request can be cached and has an appropriate Cache-Control header set. | |
| 24 | - * Each request may only perform one I/O operation on the backend. (you cannot | ||
| 25 | - make two calls to the content API or any | ||
| 26 | - other 3rd party) | ||
| 24 | + * Each request may only perform one I/O operation on the backend. (you cannot make two calls to the content API or any other 3rd party) | ||
| 27 | 25 | * The average response time of any endpoint is less than 500ms. | |
| 28 | 26 | * Requests that take longer than two seconds will be terminated. | |
| 29 | 27 | ||
@@ -40,7 +38,7 @@ Contents: | |||
| 40 | 38 | * [Additional Documentation](#additional-documentation) | |
| 41 | 39 | ||
| 42 | 40 | ## Local Test Server setup | |
| 43 | - You need A Mac or Linux PC (ubuntu). | ||
| 41 | + You need a Mac or Linux PC (Ubuntu). | ||
| 44 | 42 | ||
| 45 | 43 | Before checking out the repository you may need to [add an SSH key to your GitHub account](https://help.github.com/articles/generating-ssh-keys/). | |
| 46 | 44 | ||
@@ -53,11 +51,11 @@ Before checking out the repository you may need to [add an SSH key to your GitHu | |||
| 53 | 51 | cd frontend | |
| 54 | 52 | ``` | |
| 55 | 53 | ||
| 56 | - 2. Run ```./setup.sh``` to install dependencies and compile assets | ||
| 54 | + 2. Run `./setup.sh` to install dependencies and compile assets | ||
| 57 | 55 | 3. All being well, you should be able to [run the app](#run-the-app) | |
| 58 | 56 | ||
| 59 | 57 | ### Manual | |
| 60 | - Install each of the things listed: | ||
| 58 | + Install each of the things listed below: | ||
| 61 | 59 | ||
| 62 | 60 | #### Configuration files | |
| 63 | 61 | ||
@@ -76,7 +74,7 @@ STAGE=DEV | |||
| 76 | 74 | ||
| 77 | 75 | * `~/.aws/credentials` | |
| 78 | 76 | ||
| 79 | - Ask your team mate to create an account for you and securely send you the access key. For security, you must enable MFA - ask if you're not sure what this means. | ||
| 77 | + Ask your team mate to create an account for you and securely send you the access key. For security, you must enable MFA - ask if you're not sure what this means. | ||
| 80 | 78 | ``` | |
| 81 | 79 | [nextgen] | |
| 82 | 80 | aws_access_key_id=[YOUR_AWS_ACCESS_KEY] | |
@@ -129,7 +127,7 @@ Ubuntu: | |||
| 129 | 127 | ``` | |
| 130 | 128 | sudo apt-get install ruby ruby-dev | |
| 131 | 129 | ``` | |
| 132 | - #### [bundler](http://gembundler.com/) | ||
| 130 | + #### [Bundler](http://gembundler.com/) | ||
| 133 | 131 | ||
| 134 | 132 | Ubuntu/Mac: | |
| 135 | 133 | ``` | |
@@ -224,7 +222,7 @@ git clone git@github.com:guardian/frontend.git | |||
| 224 | 222 | ||
| 225 | 223 | Install to your IDE from http://editorconfig.org/#download | |
| 226 | 224 | ||
| 227 | - ###intelliJ metadata | ||
| 225 | + ###IntelliJ metadata | ||
| 228 | 226 | To create project files for use in IntelliJ, you need to make sure you install the Scala plugin from Preferences->Plugins. It supports SBT and Play. | |
| 229 | 227 | Then load IntelliJ, then click Import project and import the directory as an SBT project. Default settings are fine, except you need to make sure you choose JDK 1.8 (under JVM - Custom) otherwise it won't import correctly - You can find the location by pasting `/usr/libexec/java_home` into your terminal. | |
| 230 | 228 | ||
@@ -250,14 +248,12 @@ If it is owned by root, then take ownership of it | |||
| 250 | 248 | #### Global install permissions errors | |
| 251 | 249 | The script installs global npm packages without sudo. If you get npm permission errors, follow the guide to using npm without sudo [here](https://github.com/sindresorhus/guides/blob/master/npm-global-without-sudo.md). | |
| 252 | 250 | ||
| 253 | - ###phantomjs permissions errors (OSX) | ||
| 254 | - If you get an error about not having permissions to execute phantomjs during `make compile`, your machine is probably set up as managed and you'll need to ask IT to make it unmanaged. | ||
| 251 | + ###PhantomJS permissions errors (OSX) | ||
| 252 | + If you get an error about not having permissions to execute PhantomJS during `make compile`, your machine is probably set up as managed and you'll need to ask IT to make it unmanaged. | ||
| 255 | 253 | ||
| 256 | 254 | ###File handles - "Too many files open" | |
| 257 | 255 | ||
| 258 | - You may run into a "too many files open" error during | ||
| 259 | - compilation or reloading. You can find out how many file handles you are | ||
| 260 | - allowed per process by running `ulimit -n`. This can be quite low, e.g. 1024 on linux or 256 on Mac | ||
| 256 | + You may run into a "too many files open" error during compilation or reloading. You can find out how many file handles you are allowed per process by running `ulimit -n`. This can be quite low, e.g. 1024 on linux or 256 on Mac | ||
| 261 | 257 | ||
| 262 | 258 | ####Linux | |
| 263 | 259 | ||
@@ -304,28 +300,26 @@ Some packages (imagemin) are not working with newest Node.js. So if you want to | |||
| 304 | 300 | ###Memcached | |
| 305 | 301 | ||
| 306 | 302 | Memcached `sudo apt-get install memcached` - | |
| 307 | - (most of the time you do not want to use it as caching makes local development | ||
| 308 | - harder) | ||
| 303 | + (most of the time you do not want to use it as caching makes local development harder) | ||
| 309 | 304 | ||
| 310 | 305 | ###Nginx | |
| 311 | 306 | ||
| 312 | - | ||
| 313 | 307 | If you are working on Identity or Discussion, Nginx must be installed and | |
| 314 | 308 | configured to correctly serve the application, please refer to | |
| 315 | 309 | [`/nginx/README.md`](./nginx/README.md) in this project. | |
| 316 | 310 | ||
| 317 | 311 | ###Vagrant | |
| 318 | 312 | ||
| 319 | 313 | You can run the project with the supplied Vagrantfile - make sure you | |
| 320 | - understand what vagrant is http://www.vagrantup.com/ | ||
| 314 | + understand what Vagrant is http://www.vagrantup.com/ | ||
| 321 | 315 | ||
| 322 | 316 | * Make sure you have [Virtualbox](https://www.virtualbox.org/wiki/Downloads) | |
| 323 | 317 | and [Vagrant](http://docs.vagrantup.com/v2/installation/index.html) installed | |
| 324 | 318 | (on Ubuntu `sudo apt-get install virtualbox vagrant`) | |
| 325 | - * change directory into the folder where this README is located | ||
| 319 | + * Change directory into the folder where this README is located | ||
| 326 | 320 | * `vagrant up` - this will take a while, make some coffee | |
| 327 | 321 | * You can now get onto the box by `vagrant ssh` | |
| 328 | - * the project is located in /vagrant so `cd /vagrant` | ||
| 322 | + * The project is located in /vagrant so `cd /vagrant` | ||
| 329 | 323 | * `./sbt` | |
| 330 | 324 | ||
| 331 | 325 | ||
@@ -369,14 +363,13 @@ Deployment uses the [Magenta](https://github.com/guardian/deploy) library. | |||
| 369 | 363 | ||
| 370 | 364 | You can debug your local Frontend application, by attaching a debugger. | |
| 371 | 365 | ||
| 372 | - * Start Simple Build Tool in debug mode by typing `./sbt --debug` | ||
| 366 | + * Start Simple Build Tool in debug mode by typing `./sbt --debug`. | ||
| 373 | 367 | * Build and run your application. See "Running" for steps. | |
| 374 | 368 | * Use a debugger to attach to the remote Java process, on localhost:1044. | |
| 375 | 369 | ||
| 376 | - Any IDE debugger should be compatible. In IntelliJ, add a new Debug | ||
| 377 | - Configuration, based on the Remote default. | ||
| 378 | - Ensure the Transport is Socket, the Debugger mode is Attach, and the port is | ||
| 379 | - set to 1044. | ||
| 370 | + Any IDE debugger should be compatible. In IntelliJ, add a new Debug Configuration, | ||
| 371 | + based on the Remote default. | ||
| 372 | + Ensure the Transport is Socket, the Debugger mode is Attach, and the port is set to 1044. | ||
| 380 | 373 | Start a new Debug session, and your breakpoints should be active. | |
| 381 | 374 | ||
| 382 | 375 | ||
0 commit comments