diff --git a/gatsby/README.md b/gatsby/README.md index 5fb5be4..f4aa251 100644 --- a/gatsby/README.md +++ b/gatsby/README.md @@ -22,12 +22,12 @@ Gatsby and Jekyll can both be deployed on Netlify as purely static sites, which In general, you should prefer Gatsby to Jekyll when: - You have a team that has working knowledge of ES6, NPM, React, and GraphQL -- You would like to load and display data from datasources other than Markdown +- You would like to load and display data from data sources other than Markdown #### Pros - Gatsby is built on top of JavaScript, a language that we use much more regularly than Ruby. -- Gatsby supports data loading from a huge variety of datasources via its extensible data layer API. Jekyll can only read data from Markdown posts, or from specially-formatted YAML, JSON, or CSV files living in the `_data` folder. +- Gatsby supports data loading from a huge variety of data sources via its extensible data layer API. Jekyll can only read data from Markdown posts, or from specially-formatted YAML, JSON, or CSV files living in the `_data` folder. - Gatsby uses React under the hood and exposes a fully-configured React development environment, meaning you can make use of JSX and the React plugin ecosystem. Jekyll requires you to use the [Liquid templating language](https://jekyllrb.com/docs/liquid/), which does not integrate as closely with JavaScript as JSX. - Gatsby builds in a lot of performance optimizations, including code splitting, progressive rendering, and resized images for different devices. (For a deep dive on Gatsby's performance optimizations, see [Why is Gatsby so fast?](https://www.gatsbyjs.org/blog/2017-09-13-why-is-gatsby-so-fast/)) - Gatsby bakes in a modern JavaScript development environment by default, including hot reloading, source maps, and JavaScript package management. @@ -52,7 +52,6 @@ In general, you should prefer Gatsby to Django when: #### Pros - - By treating JavaScript as a first-class citizen, Gatsby and React make the process of building frontend interactions much more intuitive (and much more testable) than Django does. - Deploying on Netlify reduces the overhead of Continuous Deployment and server provisioning/management. - In addition to Gatsby's [built-in performance optimizations](https://www.gatsbyjs.org/blog/2017-09-13-why-is-gatsby-so-fast/), the fact that you're deploying static assets instead of rendering responses on a server means that a Gatsby app by default will load pages much faster than a Django app. diff --git a/postgres/README.md b/postgres/README.md index da7e791..4920999 100644 --- a/postgres/README.md +++ b/postgres/README.md @@ -1,9 +1,8 @@ # PostgreSQL -This directory records best practices for working with the object-relational -database management system PostgreSQL, our primary choice of database. +This directory records best practices for working with the object-relational database management system PostgreSQL, our primary choice of database. -## Guides +## Guides - [A quick and dirty introduction to `sqlalchemy`](./quick-n-dirty-sqlalchemy.md) - [Interacting with a remote database](./Interacting-with-a-remote-database.md) diff --git a/process/README.md b/process/README.md index 676842f..28fb960 100644 --- a/process/README.md +++ b/process/README.md @@ -1,7 +1,6 @@ # Collaborative processes -This directory records best practices for collaborative software development -processes. +This directory records best practices for collaborative software development processes. ## Guides diff --git a/shell/README.md b/shell/README.md index 48aaa53..fb38ef8 100644 --- a/shell/README.md +++ b/shell/README.md @@ -1,7 +1,6 @@ # The shell and Ubuntu -This directory records best practices for working with the shell (at DataMade, -usually Bash) and Ubuntu, our choice of operating system for our servers. +This directory records best practices for working with the shell -- typically Bash -- and Ubuntu, our choice of operating system for our servers. ## Guides