Skip to content

Commit

Permalink
Move our various docs into the docs/ directory
Browse files Browse the repository at this point in the history
  • Loading branch information
solebared committed Sep 7, 2020
1 parent 6f10cdf commit d7ca14d
Show file tree
Hide file tree
Showing 7 changed files with 10 additions and 10 deletions.
14 changes: 7 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ If you have any questions and/or are having a hard time finding where or how to
* [GitHub repo](https://github.com/rubyforgood/mutual-aid)

## Contribute!
Check out [this guide](CONTRIBUTING.md) for how to get started. We look forward to your contributions and brilliance and being!
Check out [this guide](doc/contributing.md) for how to get started. We look forward to your contributions and brilliance and being!

## Get involved in your local mutual aid efforts!
Mutual aid is not new. If it is new to you, please check out the history of mutual aid in your neighborhood or region, as likely you will find mentors and partners ready to accept your help. There are most likely leaders of color in your area. Please see if there are ways to support them before creating your own new network. There is also plenty of research to be done, and national and regional networks to connect in to.
Expand All @@ -61,15 +61,15 @@ We wrote up a [Glossary of terms](http://mutual-aid-demo.herokuapp.com/admin/glo
You can also review it [in code](app/views/admin/glossary.html.erb).

## Deploying the app
Visit our [DEPLOYMENT.md](DEPLOYMENT.md) guide for more information on deploying the app.
Visit our [deployment guide](doc/deployment.md) for more information on deploying the app.

## More guides and documentation
* [Contribution guide](CONTRIBUTING.md)
* [Contribution guide](doc/contributing.md)
* [Code of conduct](https://github.com/rubyforgood/code-of-conduct)
* [Changelog](CHANGELOG.md)
* [Dev environment setup](SETUP.md)
* [Seeding and importing data](SEEDING.md)
* [Some testing tips](TESTING.md)
* [Dev environment setup](doc/setup.md)
* [Seeding and importing data](doc/seeding.md)
* [Some testing tips](doc/testing.md)
* [Rudimentary ERD and workflow diagrams](db/db_diagram_yEd.graphml)
* Customization (WIP)

Expand All @@ -82,4 +82,4 @@ The idea is that each group -- or cluster of groups -- would own their database

Ideally mutual aid networks will have their own tech teams, but we will provide initial support as capacity permits.

Feel free to [browse some of our earliest notes](ORIENTATION.md).
Feel free to browse [some of our earliest notes](doc/orientation.md).
4 changes: 2 additions & 2 deletions CONTRIBUTING.md → doc/contributing.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ In any case, go ahead and 'Assign' yourself to the issue (if someone's already a
Once you start working on the issue in earnest, please move it into the 'In progress' column on the [Roadmap].

## Setup your development environment
See [SETUP.md](SETUP.md)
See our [setup guide](doc/setup.md).

## Put together a Pull Request

Expand All @@ -31,7 +31,7 @@ Here are the basic steps to submit a pull request. Make sure that you're working

1. Run the test suite (`bin/rake`). We only merge pull requests with a passing test suite, and it's great to know that you have a clean slate.

1. Add your code and tests as needed. If you are adding functionality or fixing a bug, you probably should add a test or many (if you're not sure how, comment and we might able to help)! See [TESTING.md](TESTING.md) for some testing tips relevant to this codebase.
1. Add your code and tests as needed. If you are adding functionality or fixing a bug, you probably should add a test or many (if you're not sure how, comment and we might able to help)! See [doc/testing.md](doc/testing.md) for some testing tips relevant to this codebase.

1. Check the files that you added or changed with Rubocop, a ruby code linter: `bundle exec rubocop path/file1 path/file2`. You can add the `-a` option to fix some offenses automatically. Fix the others by hand until Rubocop reports no more offenses.

Expand Down
File renamed without changes.
File renamed without changes.
File renamed without changes.
2 changes: 1 addition & 1 deletion SETUP.md → doc/setup.md
Original file line number Diff line number Diff line change
Expand Up @@ -146,7 +146,7 @@ You should now be able to see the app running at http://localhost:3000


## Running tests
See [TESTING.md](TESTING.md).
See [doc/testing.md](doc/testing.md).


## Note about deprecation warnings.
Expand Down
File renamed without changes.

0 comments on commit d7ca14d

Please sign in to comment.