Creates a guide-template to update all guides from #2

Open
wants to merge 7 commits into
base: master
from
Next

Reformat markdown to begin cleanup

- Much of this will be rewritten but let's start with a happy markdown linter.
  • Loading branch information...
bengitscode committed Nov 21, 2017
commit a435bf5b7ff92b55a2547bf3919d906c52924463
Copy path View file
@@ -8,49 +8,48 @@ Be sure to include a recent LICENSE and Markdown linter configuration (.remarkrc

## Prerequisites

- [ga-wdi-boston/rails-api](https://github.com/ga-wdi-boston/rails-api)
- [ga-wdi-boston/rails-activerecord-crud](https://github.com/ga-wdi-boston/rails-activerecord-crud)
- This guide assumes you have followed [these installation instructions](https://github.com/ga-wdi-boston/rails-api-template#installation) unequivocally.
- [ga-wdi-boston/rails-api](https://github.com/ga-wdi-boston/rails-api)
- [ga-wdi-boston/rails-activerecord-crud](https://github.com/ga-wdi-boston/rails-activerecord-crud)
- This guide assumes you have followed [these installation instructions](https://github.com/ga-wdi-boston/rails-api-template#installation) unequivocally.

## Objectives

By the end of this, developers should be able to:
- What should developers accomplish by following this guide.
- Write objectives that focus on demonstrating knowledge.
- Write learning objectives that begin with an [imperative
verb](https://en.wikipedia.org/wiki/Imperative_mood).
- Avoid objectives that start with "Use" or "Understand".
- Rewrite objecives that begin with "Use" by inverting sentence structure.
- End each objective with a period.

Write objectives that focus on demonstrating knowledge.
Write learning objectives that begin with an imperative verb.
Avoid objectives that start with "Use" or "Understand".
Rewrite objectives that begin with "Use" by inverting sentence structure.
End each objective with a period.


## Getting Set Up
## Preparation

Often there will be setup instructions preceding the core objectives of the setup guide, such as `create an account on foo or bar`
The following is an example using heroku.

1. **Create a Heroku account**, at [https://www.heroku.com](https://www.heroku.com).
1 **Create a Heroku account**, at [https://www.heroku.com](https://www.heroku.com).
You will be sent an activation email, so be sure to check your inbox so that
you can activate your account.
1. Install the Heroku Command Line Tools: run `brew install heroku`.
1. **Log into Heroku** by running `heroku login` from the console and providing
1. Install the Heroku Command Line Tools: run `brew install heroku`.
1. **Log into Heroku** by running `heroku login` from the console and providing
your Heroku credentials when asked. Once you log in, if you're prompted
to add these credentials to your keychain, say yes. *You will not be able*
*to see your password*


### Create a New Heroku App
### Checklist

Go to the root of your repo and run `heroku create`. This will create an
_autogenerated_ name for your app, and add a new remote repository to your repo
called _heroku_. View your remotes by typing `git remote -v`. You should see
something like:
Each step for guide should be represented in here as a checklist item and below this checklist
as an individual third-level header.

```sh
heroku git@heroku.com:agile-badlands-7658.git (fetch)
heroku git@heroku.com:agile-badlands-7658.git (push)
origin git@github.com:tdyer/wdi_4_rails_hw_tdd_hacker_news.git (fetch)
origin git@github.com:tdyer/wdi_4_rails_hw_tdd_hacker_news.git (push)
```
- [x] [Github and Initial Setup](github.md)
- [ ] [Homebrew](homebrew.md)
- [ ] [Node](node.md)
- [ ] [Ruby](ruby.md)
- [ ] [PostgreSQL](postgres.md)
- [ ] [Atom](atom.md)
- [ ] [Chrome](chrome.md)

### Push `master` to Heroku

@@ -176,22 +175,22 @@ S3](https://aws.amazon.com/s3/); more on this in the near future.

Provide checklist of steps outlined above.

- [ ] Run `heroku create` in the command line in the root of your Rails API to
create a new (blank) app on Heroku.
- [ ] Push your latest code to Heroku (`git push heroku master`)
- [ ] Update your heroku database by telling Heroku to run your migration files (`heroku run rake db:migrate`).
- [ ] Run `heroku create` in the command line in the root of your Rails API to create a new (blank) app on Heroku.
- [ ] Push your latest code to Heroku (`git push heroku master`)
- [ ] Update your heroku database by telling Heroku to run your migration files (`heroku run rake db:migrate`).
If you have any other rake tasks that need to run (e.g. `rake db:seed`), run
those with `heroku run` as well.
- [ ] Set your secrets. (Either by using the [command line](#set-your-secrets) or by using the
- [ ] Set your secrets. (Either by using the [command line](#set-your-secrets) or by using the
heroku app panel in your browser)
- [ ] Check your work by restarting heroku and opening your heroku application.
[ ] Check your work by restarting heroku and opening your heroku application.


## Troubleshooting

Provide troubleshooting resources/gotchas if needed.

These are the commands required for deploying to heroku with rails. If your heroku deployment isn't working as expected, review these steps carefully.

- `heroku create`
- `git push heroku master`
- `heroku run rake db:migrate`
@@ -205,11 +204,17 @@ These are the commands required for deploying to heroku with rails. If your hero

## Additional Resources

- [Heroku Command Line](https://devcenter.heroku.com/categories/command-line)
- [Heroku Rails Deployment](https://devcenter.heroku.com/articles/getting-started-with-rails5)
- Any useful links should be included in the talk material where the link is
first referenced.
- Additional links for further study or exploration are appropriate in this
section.
- Links to relevant resources or documentation not included in the guide, or tools tangentially used but not part of the focus of the guide/task are also appropriate.
- Examples:
- [Heroku Command Line](https://devcenter.heroku.com/categories/command-line)
- [Heroku Rails Deployment](https://devcenter.heroku.com/articles/getting-started-with-rails5)

## [License](LICENSE)

1. All content is licensed under a CC­BY­NC­SA 4.0 license.
1. All software code is licensed under GNU GPLv3. For commercial use or
1. All content is licensed under a CC­BY­NC­SA 4.0 license.
1. All software code is licensed under GNU GPLv3. For commercial use or
alternative licensing, please contact legal@ga.co.
ProTip! Use n and p to navigate between commits in a pull request.