diff --git a/README.md b/README.md index 404dbc94398..06bb04d35db 100644 --- a/README.md +++ b/README.md @@ -13,9 +13,9 @@ Whenever you need ... ## Getting Started -If you're interested in helping us develop Discourse, please start with our **[Discourse Vagrant Developer Guide](https://github.com/discourse/discourse/blob/master/VAGRANT.md)**, which includes instructions to get up and running in a development environment using a virtual machine. It's the easiest way to hack on Discourse. +If you're interested in helping us develop Discourse, please start with our **[Discourse Vagrant Developer Guide](https://github.com/discourse/discourse/blob/master/docs/VAGRANT.md)**, which includes instructions to get up and running in a development environment using a virtual machine. It's the easiest way to hack on Discourse. -If you're familiar with how Rails works and are comfortable setting up your own environemnt, you can use our **[Discourse Advanced Developer Guide](https://github.com/discourse/discourse/blob/master/DEVELOPER-ADVANCED.md)** +If you're familiar with how Rails works and are comfortable setting up your own environemnt, you can use our **[Discourse Advanced Developer Guide](https://github.com/discourse/discourse/blob/master/docs/DEVELOPER-ADVANCED.md)** ### Requirements @@ -62,7 +62,7 @@ In order to be prepared for contributing to Discourse, please: 1. Review the **VISION** section above, which will help you understand the needs of the team, and the focus of the project, 2. Read & sign the **[Electronic Discourse Forums Contribution License Agreement](https://docs.google.com/a/discourse.org/spreadsheet/viewform?formkey=dGUwejFfbDhDYXR4bVFMRG1TUENqLWc6MQ)**, to confirm you've read and acknowledged the legal aspects of your contributions, and -3. Dig into **[CONTRIBUTING.MD](https://github.com/discourse/discourse/blob/master/CONTRIBUTING.md)**, which houses all of the necessary info to: +3. Dig into **[CONTRIBUTING.MD](https://github.com/discourse/discourse/blob/master/docs/CONTRIBUTING.md)**, which houses all of the necessary info to: * submit bugs, * request new features, and * step you through the entire process of preparing your code for a Pull Request. @@ -85,7 +85,7 @@ Discourse implements a variety of open source tech. You may wish to familiarize ### Ruby Gems -The complete list of Ruby Gems used by Discourse can be found in [SOFTWARE.md](https://github.com/discourse/discourse/blob/master/SOFTWARE.md). +The complete list of Ruby Gems used by Discourse can be found in [SOFTWARE.md](https://github.com/discourse/discourse/blob/master/docs/SOFTWARE.md). ## Versioning @@ -105,7 +105,7 @@ For more information on SemVer, please visit http://semver.org/. ## The Discourse Team -The Discourse code contributors can be found in [AUTHORS.MD](https://github.com/discourse/discourse/blob/master/AUTHORS.md). For a complete list of the many individuals that contributed to the design and implementation of Discourse, please refer to the official website. +The Discourse code contributors can be found in [AUTHORS.MD](https://github.com/discourse/discourse/blob/master/docs/AUTHORS.md). For a complete list of the many individuals that contributed to the design and implementation of Discourse, please refer to the official website. ## Copyright / License diff --git a/AUTHORS.md b/docs/AUTHORS.md similarity index 100% rename from AUTHORS.md rename to docs/AUTHORS.md diff --git a/CONTRIBUTING.md b/docs/CONTRIBUTING.md similarity index 100% rename from CONTRIBUTING.md rename to docs/CONTRIBUTING.md diff --git a/DEVELOPER-ADVANCED.md b/docs/DEVELOPER-ADVANCED.md similarity index 95% rename from DEVELOPER-ADVANCED.md rename to docs/DEVELOPER-ADVANCED.md index 89cc2594109..b998d35643f 100644 --- a/DEVELOPER-ADVANCED.md +++ b/docs/DEVELOPER-ADVANCED.md @@ -1,7 +1,7 @@ # Discourse Advanced Developer Install Guide This guide is aimed at advanced Rails developers who have installed their own Rails apps before. If you are new -to rails, you are likely much better off with our **[Discourse Vagrant Developer Guide](https://github.com/discourse/discourse/blob/master/VAGRANT.md)**. +to rails, you are likely much better off with our **[Discourse Vagrant Developer Guide](https://github.com/discourse/discourse/blob/master/docs/VAGRANT.md)**. ## First Steps @@ -27,7 +27,7 @@ You should now be able to connect to rails on http://localhost:3000 - try it out # Building your own Vagrant VM -Here are the steps we used to create the **[Vagrant Virtual Machine](https://github.com/discourse/discourse/blob/master/VAGRANT.md)**. They might be useful if you plan on setting up an environment from scratch on Linux: +Here are the steps we used to create the **[Vagrant Virtual Machine](https://github.com/discourse/discourse/blob/master/docs/VAGRANT.md)**. They might be useful if you plan on setting up an environment from scratch on Linux: ## Base box @@ -125,4 +125,4 @@ Load it (as vagrant user): cd utils ./install_server.sh # Press enter to accept all the defaults - /etc/init.d/redis_6379 start \ No newline at end of file + /etc/init.d/redis_6379 start diff --git a/INSTALL.md b/docs/INSTALL.md similarity index 100% rename from INSTALL.md rename to docs/INSTALL.md diff --git a/PLUGINS.md b/docs/PLUGINS.md similarity index 100% rename from PLUGINS.md rename to docs/PLUGINS.md diff --git a/SOFTWARE.md b/docs/SOFTWARE.md similarity index 100% rename from SOFTWARE.md rename to docs/SOFTWARE.md diff --git a/VAGRANT.md b/docs/VAGRANT.md similarity index 97% rename from VAGRANT.md rename to docs/VAGRANT.md index 5addb73ef17..e2503c288da 100644 --- a/VAGRANT.md +++ b/docs/VAGRANT.md @@ -1,7 +1,7 @@ # Discourse Developer Install Guide (Vagrant) If you'd like to set up a development environment for Discourse, the easiest way is by using a virtual machine. -If you have experience setting up Rails projects, you might want to take a look at our **[Discourse Advanced Developer Guide](https://github.com/discourse/discourse/blob/master/DEVELOPER-ADVANCED.md)**. +If you have experience setting up Rails projects, you might want to take a look at our **[Discourse Advanced Developer Guide](https://github.com/discourse/discourse/blob/master/docs/DEVELOPER-ADVANCED.md)**. It also contains instructions on building your own Vagrant VM. The following instructions will automatically download and provision a virtual machine for you to begin hacking