diff --git a/GETTING_STARTED.md b/GETTING_STARTED.md index 8e9c087b76..f1dd8679aa 100644 --- a/GETTING_STARTED.md +++ b/GETTING_STARTED.md @@ -73,9 +73,9 @@ Then the tests can be run with: bundle exec rspec spec -The project is configured to use [Zeus](zeus) to reduce the pre-test startup time while Rails loads. See the [Zeus GitHub page](zeus) for usage instructions. +The project is configured to use [Zeus][zeus] to reduce the pre-test startup time while Rails loads. See the [Zeus GitHub page][zeus] for usage instructions. -Once [npm dependencies are installed](karma), AngularJS tests can be run with: +Once [npm dependencies are installed][karma], AngularJS tests can be run with: ./script/karma run @@ -87,7 +87,7 @@ If you want karma to automatically rerun the tests on file modification, use: Do not forget to run `rake tmp:cache:clear` after locales are updated to reload I18n js translations. ### Rubocop -The project is configured to use [rubocop](rubocop) to automatically check for style and syntax errors. +The project is configured to use [rubocop][rubocop] to automatically check for style and syntax errors. You can run rubocop against your changes using: diff --git a/README.md b/README.md index d1bf86b655..6b71fdb766 100644 --- a/README.md +++ b/README.md @@ -11,22 +11,22 @@ Supported by the Open Food Foundation and a network of global affiliates, we are We're part of global movement - get involved! * Fill in this [short survey](survey) to tell us who you are and what you want to do with OFN. -* Join the conversation [on Slack](slack). Make sure you introduce yourself in the #general channel. +* Join the conversation [on Slack][slack-invite]. Make sure you introduce yourself in the #general channel * Head to [https://openfoodnetwork.org](https://openfoodnetwork.org) for more information about the global OFN project. * Check out the [User Guide](https://guide.openfoodnetwork.org/) for a list of features and tutorials. * Join our [discussion forum](https://community.openfoodnetwork.org). ## Contributing -If you are interested in contributing to the OFN in any capacity, please introducing yourself [on Slack](slack), and have a look through our [Contributor Guide](contributor-guide) +If you are interested in contributing to the OFN in any capacity, please introducing yourself [on Slack][slack-invite], and have a look through our [Contributor Guide][contributor-guide] Our [GETTING_STARTED](GETTING_STARTED.md) and [CONTRIBUTING](CONTRIBUTING.md) guides are the best place to start for developers looking to set up a development environment and make contributions to the codebase. ## Provisioning -If you're interested in provisioning a server, see [ofn-install](ofn-install) for the project's Ansible playbooks. +If you're interested in provisioning a server, see [ofn-install][ofn-install] for the project's Ansible playbooks. -We also have a [Super Admin Guide](super-admin-guide) to help with configuration of new servers. +We also have a [Super Admin Guide][super-admin-guide] to help with configuration of new servers. ## Credits @@ -52,7 +52,7 @@ We also have a [Super Admin Guide](super-admin-guide) to help with configuration Copyright (c) 2012 - 2018 Open Food Foundation, released under the AGPL licence. [survey]: https://docs.google.com/a/eaterprises.com.au/forms/d/1zxR5vSiU9CigJ9cEaC8-eJLgYid8CR8er7PPH9Mc-30/edit# -[slack]: https://openfoodnetwork.org/slack-invite +[slack-invite]: https://openfoodnetwork.org/slack-invite [contributor-guide]: https://ofn-user-guide.gitbook.io/ofn-contributor-guide/who-are-we [ofn-install]: https://github.com/openfoodfoundation/ofn-install [super-admin-guide]: https://ofn-user-guide.gitbook.io/ofn-super-admin-guide