Removing documentation from the repo and moving to wiki

REBELinBLUE · Jan 22, 2017 · eb60331 · eb60331
1 parent 93da387
commit eb60331
Show file tree

Hide file tree

Showing 34 changed files with 8 additions and 184 deletions.
diff --git a/.gitattributes b/.gitattributes
@@ -63,7 +63,7 @@ VERSION text
 #
 
 tests/ export-ignore
-docs/examples/dev/ export-ignore
+examples/ export-ignore
 .github/ export-ignore
 .gitattributes export-ignore
 .gitignore export-ignore

diff --git a/README.md b/README.md
@@ -12,7 +12,7 @@
 
 Deployer is a PHP Application deployment system powered by [Laravel 5.3](http://laravel.com), written & maintained by [Stephen Ball](https://github.com/REBELinBLUE).
 
-Check out the [releases](https://github.com/REBELinBLUE/deployer/releases), [license](/LICENSE.md), [screenshots](/docs/SCREENSHOTS.md), [FAQs](/docs/FAQ.md) and [contribution guidelines](/.github/CONTRIBUTING.md).
+Check out the [releases](https://github.com/REBELinBLUE/deployer/releases), [license](/LICENSE.md), [screenshots](https://github.com/REBELinBLUE/deployer/wiki/Screenshots) and [contribution guidelines](/.github/CONTRIBUTING.md).
 
 ## What it does
 
@@ -38,87 +38,17 @@ The `master` branch of this repository is a development branch and **should not*
 
 ## Requirements
 
-- [PHP](http://www.php.net) 5.6.4+ or newer
-- A database, either [MySQL](https://www.mysql.com) or [PostgreSQL](http://www.postgresql.org) ([SQLite](https://www.sqlite.org) can also be used but is not recommended).
-- [Composer](https://getcomposer.org)
-- [Redis](http://redis.io)
-- [Node.js](https://nodejs.org/)
-- [Beanstalkd](http://kr.github.io/beanstalkd/) for queuing jobs. Although Laravel can use redis there is currently [an issue when using more than 1 queue worker](https://github.com/laravel/framework/issues/8577), the default in Deployer is 3.
-
-### Optional extras
-
-- [Supervisor](http://supervisord.org) to keep the queue listener and Node.js socket server running
-- A [caching server](http://laravel.com/docs/5.2/cache), unless you expect a lot of traffic the default `file` cache is probably enough
-- [Yarn](https://yarnpkg.com/) an improved package manager for Node.js
+See the [list of requirements](https://github.com/REBELinBLUE/deployer/wiki/System-Requirements).
 
 ## Installation
 
-1. Clone the repository
-
-```shell
-$ git clone https://github.com/REBELinBLUE/deployer.git
-```
-
-2. Checkout the latest release
-
-```shell
-$ git checkout 0.0.40
-```
-
-3. Install dependencies
-
-```shell
-$ composer install -o --no-dev
-$ npm install --production
-```
-
-4. Make sure the storage and upload directories are writable
-
-```shell
-$ chmod -R 777 storage
-$ chmod -R 777 public/upload
-```
-
-5. Run the installer and follow the instructions
-
-```shell
-$ php artisan app:install
-```
+See the [installation instructions](https://github.com/REBELinBLUE/deployer/wiki/Installation).
 
-6. (Optional) Make any additional configuration changes
+## Updating
 
-```shell
-$ editor .env
-```
-
-7. Configure your web server to point to `public/`, see `docs/examples/` for Apache and nginx sample configuration files. If you use Apache you will need to ensure you have the `mod_rewrite` module enabled.
-
-8. Start socket server and setup cron jobs.
-    If you are not configuring `supervisor` you will need to manually start the socket server with `node socket.js` (listens on port 6001 by default) and setup cron jobs, see `docs/examples/crontab`.
-    If you are configuring `supervisor` see `docs/examples/supervisor.conf`
-
-### Updating
-
-1. Get the latest code
-
-```shell
-$ git fetch --all
-$ git checkout 0.0.40
- ```
-
-2. Update the dependencies
-
-```shell
-$ composer install -o --no-dev
-$ npm install --production
-```
-
-3. Run the updater
-
-```shell
-$ php artisan app:update
-```
+See the [updating instructions](https://github.com/REBELinBLUE/deployer/wiki/Upgradingd).
 
 ## License
 
 Deployer is licensed under [The MIT License (MIT)](/LICENSE.md).
+
diff --git a/app/Console/Commands/InstallApp.php b/app/Console/Commands/InstallApp.php
@@ -115,7 +115,7 @@ public function handle()
         $this->line('');
 
         $instructions = [
-            'Example configuration files can be found in the <options=bold>docs/examples</> directory',
+            'Example configuration files can be found in the <options=bold>examples</> directory',
             'Set up your web server, see either <options=bold>nginx.conf</> or <options=bold>apache.conf</>',
             'Setup the cronjobs, see <options=bold>crontab</>',
             'Setup the socket server & queue runner, see <options=bold>supervisor.conf</> for an example setup',

diff --git a/docs/FAQ.md b/docs/FAQ.md
diff --git a/docs/NOTIFICATIONS.md b/docs/NOTIFICATIONS.md
diff --git a/docs/SCREENSHOTS.md b/docs/SCREENSHOTS.md
diff --git a/docs/WEBHOOKS.md b/docs/WEBHOOKS.md
diff --git a/docs/examples/ansible/README.md → examples/ansible/README.md b/docs/examples/ansible/README.md → examples/ansible/README.md
diff --git a/...xamples/ansible/group_vars/production.yml → examples/ansible/group_vars/production.yml b/...xamples/ansible/group_vars/production.yml → examples/ansible/group_vars/production.yml
diff --git a/docs/examples/ansible/hosts → examples/ansible/hosts b/docs/examples/ansible/hosts → examples/ansible/hosts
diff --git a/docs/examples/ansible/playbook.yml → examples/ansible/playbook.yml b/docs/examples/ansible/playbook.yml → examples/ansible/playbook.yml
diff --git a/.../ansible/roles/deployer/handlers/main.yml → .../ansible/roles/deployer/handlers/main.yml b/.../ansible/roles/deployer/handlers/main.yml → .../ansible/roles/deployer/handlers/main.yml
diff --git a/...les/ansible/roles/deployer/tasks/main.yml → ...les/ansible/roles/deployer/tasks/main.yml b/...les/ansible/roles/deployer/tasks/main.yml → ...les/ansible/roles/deployer/tasks/main.yml
diff --git a/...roles/deployer/templates/deployer.conf.j2 → ...roles/deployer/templates/deployer.conf.j2 b/...roles/deployer/templates/deployer.conf.j2 → ...roles/deployer/templates/deployer.conf.j2
diff --git a/.../roles/deployer/templates/env.deployer.j2 → .../roles/deployer/templates/env.deployer.j2 b/.../roles/deployer/templates/env.deployer.j2 → .../roles/deployer/templates/env.deployer.j2
diff --git a/...les/deployer/templates/supervisor.conf.j2 → ...les/deployer/templates/supervisor.conf.j2 b/...les/deployer/templates/supervisor.conf.j2 → ...les/deployer/templates/supervisor.conf.j2
diff --git a/...amples/ansible/roles/mysql/tasks/main.yml → examples/ansible/roles/mysql/tasks/main.yml b/...amples/ansible/roles/mysql/tasks/main.yml → examples/ansible/roles/mysql/tasks/main.yml
diff --git a/...es/ansible/roles/nginx/files/fastcgi.conf → ...es/ansible/roles/nginx/files/fastcgi.conf b/...es/ansible/roles/nginx/files/fastcgi.conf → ...es/ansible/roles/nginx/files/fastcgi.conf
diff --git a/...les/ansible/roles/nginx/handlers/main.yml → ...les/ansible/roles/nginx/handlers/main.yml b/...les/ansible/roles/nginx/handlers/main.yml → ...les/ansible/roles/nginx/handlers/main.yml
diff --git a/...amples/ansible/roles/nginx/tasks/main.yml → examples/ansible/roles/nginx/tasks/main.yml b/...amples/ansible/roles/nginx/tasks/main.yml → examples/ansible/roles/nginx/tasks/main.yml
diff --git a/...sible/roles/nginx/templates/vhost.conf.j2 → ...sible/roles/nginx/templates/vhost.conf.j2 b/...sible/roles/nginx/templates/vhost.conf.j2 → ...sible/roles/nginx/templates/vhost.conf.j2
diff --git a/...mples/ansible/roles/nodejs/tasks/main.yml → examples/ansible/roles/nodejs/tasks/main.yml b/...mples/ansible/roles/nodejs/tasks/main.yml → examples/ansible/roles/nodejs/tasks/main.yml
diff --git a/...ples/ansible/roles/php/files/php-fpm.conf → ...ples/ansible/roles/php/files/php-fpm.conf b/...ples/ansible/roles/php/files/php-fpm.conf → ...ples/ansible/roles/php/files/php-fpm.conf
diff --git a/...mples/ansible/roles/php/handlers/main.yml → examples/ansible/roles/php/handlers/main.yml b/...mples/ansible/roles/php/handlers/main.yml → examples/ansible/roles/php/handlers/main.yml
diff --git a/...examples/ansible/roles/php/tasks/main.yml → examples/ansible/roles/php/tasks/main.yml b/...examples/ansible/roles/php/tasks/main.yml → examples/ansible/roles/php/tasks/main.yml
diff --git a/...es/ansible/roles/php/templates/php.ini.j2 → ...es/ansible/roles/php/templates/php.ini.j2 b/...es/ansible/roles/php/templates/php.ini.j2 → ...es/ansible/roles/php/templates/php.ini.j2
diff --git a/...le/roles/php/templates/phpmyadmin.conf.j2 → ...le/roles/php/templates/phpmyadmin.conf.j2 b/...le/roles/php/templates/phpmyadmin.conf.j2 → ...le/roles/php/templates/phpmyadmin.conf.j2
diff --git a/...s/ansible/roles/php/templates/www.conf.j2 → ...s/ansible/roles/php/templates/www.conf.j2 b/...s/ansible/roles/php/templates/www.conf.j2 → ...s/ansible/roles/php/templates/www.conf.j2
diff --git a/...mples/ansible/roles/server/tasks/main.yml → examples/ansible/roles/server/tasks/main.yml b/...mples/ansible/roles/server/tasks/main.yml → examples/ansible/roles/server/tasks/main.yml
diff --git a/docs/examples/ansible/vars/server.yml → examples/ansible/vars/server.yml b/docs/examples/ansible/vars/server.yml → examples/ansible/vars/server.yml
diff --git a/docs/examples/apache.conf → examples/apache.conf b/docs/examples/apache.conf → examples/apache.conf
diff --git a/docs/examples/crontab → examples/crontab b/docs/examples/crontab → examples/crontab
diff --git a/docs/examples/nginx.conf → examples/nginx.conf b/docs/examples/nginx.conf → examples/nginx.conf
diff --git a/docs/examples/supervisor.conf → examples/supervisor.conf b/docs/examples/supervisor.conf → examples/supervisor.conf