docbrown/docs/faqs.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

32 lines
896 B
Markdown

---
title: FAQs
---
# Frequently Asked Questions
## How do I build my local copy of the Ruby source code documentation?
```shell
cd docs
make ruby-doc
```
Then open `.static/ruby-doc/index.html` in the `docs` directory and browse the
Ruby documentation
## How do I fix the Error `role "ec2-user" does not exist` on an AWS instance?
After installing and configuring PostgreSQL on an AWS EC2 (or AWS Cloud9)
instance and running `bin/setup`, this error could occur.
To fix it, run the following two commands in a terminal (assuming your
PostgreSQL user is named **postgres**):
```
sudo -u postgres createuser -s ec2-user
sudo -u postgres createdb ec2-user
```
The first command creates the user **ec2-user** and the second one creates the
database for this user because every user needs its database. Even if the first
command fails, run the second command to create the missing database.