docbrown/docs/installation/readme.md
Jacob Herrington 7d0aeeefe5 Improve the clarity of the docs and fix Prettier config (#4899)
* Improve format and clarity of the docs [ci skip]

While this change produces a lot of git noise by enacting what seems
like an arbitrary linewrap on most of the files in the documentation it
will result in better version control and tracking of the changes in the
documentation.

For example, as it currently stands, if one was to make a
PR to move a comma in a sentence because each paragraph in most of the
files is on a single line, that small change would look in the git
history like the author had modified the entire paragraph. In reality,
this author just moved a comma.

This change also includes a significant number of modifications to the
more article-esque docs. Many of these docs were written in a sort of
stream-of-conciousness and aren't as easy to read as they could be.
Hopefully this is the first of several readability changes. If we could
get these docs to a more accessible reading level, we would probably see
an increase in contributions. :)

* Delegate markdown wrapping to Prettier

* Add linewrapping explanation in the docs [ci skip]
2019-11-26 08:40:53 -05:00

41 lines
1.3 KiB
Markdown

---
items:
- mac.md
- windows.md
- linux.md
- docker.md
- gitpod.md
- postgresql.md
---
# Installation Guide
There are many different ways you can install the **development environment** so
you can help contribute code to DEV.
## Installing locally
You can install DEV to your local machine and we have instructions for
[Mac](/installation/mac), [Windows](/installation/windows) and
[Linux](/installation/linux).
## Running Docker
Installing to your local machine can be troublesome for many reasons such as a
conflicting database and runtime versions.
Another way you can get a development environment up and running is with Docker.
Docker will install everything you need in an isolated container, and you need
not concern about the details. We have instructions for installing with
[Docker](/installation/docker).
## GitPod _- beginner friendly!_
If you are having trouble with local installation and Docker confuses you, then
you can launch a **development environment** with the press of a button with
GitPod.
GitPod is an IDE in the cloud which is also attached to a web server. It will
install everything you need. If you are comfortable doing everything from a web
browser, then we have instructions for installing with
[GitPod](/installation/gitpod) as well.