Moving docs to readme. (#275)

acquia · Aug 9, 2016 · a05f34b · a05f34b
1 parent b391fc1
commit a05f34b
Show file tree

Hide file tree

Showing 20 changed files with 19 additions and 19 deletions.
diff --git a/INSTALL.md b/INSTALL.md
@@ -107,11 +107,11 @@ Note that all of the steps from this point forward are the same steps that would
 
 Before building your project dependencies and installing Drupal, you must have a fully functional \*AMP stack on your local machine. BLT intentionally does not provide this local development environment--that is outside of the scope of BLT’s intended responsibilities. It does, however, make recommendations for which tools you should use to manage your stack.
 
-Please see [Local Development](docs/local-development.md) for more information on setting up your \*AMP stack:
+Please see [Local Development](readme/local-development.md) for more information on setting up your \*AMP stack:
 
-* [Acquia Dev Desktop](docs/local-development.md#using-acquia-dev-desktop-for-blt-generated-projects)
-* [Drupal VM](docs/local-development.md#using-drupal-vm-for-blt-generated-projects)
-* [Other](https://github.com/acquia/blt/blob/8.x/docs/local-development.md#alternative-local-development-environments)
+* [Acquia Dev Desktop](readme/local-development.md#using-acquia-dev-desktop-for-blt-generated-projects)
+* [Drupal VM](readme/local-development.md#using-drupal-vm-for-blt-generated-projects)
+* [Other](readme/local-development.md#alternative-local-development-environments)
 
 When you have completed setting up your local \*AMP stack, double check that the following pieces of information are still correct:
 

diff --git a/README.md b/README.md
@@ -43,12 +43,12 @@ It scope is discretely defined. It is *not* intended to provide:
 * [Testing Framework](template/tests).
     * Behat: default `local.yml` configuration, example tests, `FeatureContext.php`
     * PHPUnit: default tests for ensuring proper functioning of BLT provided components
-* [Project tasks](docs/project-tasks.md)
+* [Project tasks](readme/project-tasks.md)
     * Executing tests and validating code
     * Building dependencies
     * (Re)installation of Drupal
     * Production-safe artifact generation and deployment
-* [Continuous Integration](docs/ci.md)
+* [Continuous Integration](readme/ci.md)
     * Travis CI
     * GitHub
 

diff --git a/mkdocs.yml b/mkdocs.yml
@@ -13,29 +13,29 @@ pages:
   - Overview: 'README.md'
   - Getting started:
     - Installation & upgrade:  'INSTALL.md'
-    - Local development: 'docs/local-development.md'
+    - Local development: 'readme/local-development.md'
   - Project documentation:
     - Overview: 'template/README.md'
     - Developer:
-          - Onboarding: 'docs/onboarding.md'
-          - Repository architecture: 'docs/repo-architecture.md'
+          - Onboarding: 'readme/onboarding.md'
+          - Repository architecture: 'readme/repo-architecture.md'
           - Running project tasks:
-            - Overview: 'docs/project-tasks.md'
+            - Overview: 'readme/project-tasks.md'
             - Patches: 'template/patches/README.md'
             - Drush: 'template/drush/README.md'
             - Git hooks: 'template/scripts/git-hooks/README.md'
           - Best practices:
-            - Overview: 'docs/best-practices.md'
-            - Views: 'docs/views.md'
-          - Workflow: 'docs/dev-workflow.md'
+            - Overview: 'readme/best-practices.md'
+            - Views: 'readme/views.md'
+          - Workflow: 'readme/dev-workflow.md'
           - Automated testing: 'template/tests/README.md'
     - Technical Architect:
-        - Project architecture document: 'docs/architecture.md'
-        - Deploying to cloud: 'docs/deploy.md'
+        - Project architecture document: 'readme/architecture.md'
+        - Deploying to cloud: 'readme/deploy.md'
         - Releases:
-          - Release process: 'docs/release-process.md'
+          - Release process: 'readme/release-process.md'
           - Release notes: 'scripts/release-notes/README.md'
-        - Setting up continuous integration: 'docs/ci.md'
-        - Open source contribution: 'docs/os-contribution.md'
-  - Extending / Overriding BLT: 'docs/extending-blt.md'
+        - Setting up continuous integration: 'readme/ci.md'
+        - Open source contribution: 'readme/os-contribution.md'
+  - Extending / Overriding BLT: 'readme/extending-blt.md'
   - Contributing: 'CONTRIBUTING.md'
diff --git a/docs/acsf-setup.md → readme/acsf-setup.md b/docs/acsf-setup.md → readme/acsf-setup.md
diff --git a/docs/architecture.md → readme/architecture.md b/docs/architecture.md → readme/architecture.md
diff --git a/docs/best-practices.md → readme/best-practices.md b/docs/best-practices.md → readme/best-practices.md
diff --git a/docs/ci.md → readme/ci.md b/docs/ci.md → readme/ci.md
diff --git a/docs/code-review.md → readme/code-review.md b/docs/code-review.md → readme/code-review.md
diff --git a/docs/deploy.md → readme/deploy.md b/docs/deploy.md → readme/deploy.md
diff --git a/docs/dev-workflow.md → readme/dev-workflow.md b/docs/dev-workflow.md → readme/dev-workflow.md
diff --git a/docs/examples/readme.md → readme/examples/readme.md b/docs/examples/readme.md → readme/examples/readme.md
diff --git a/docs/extending-blt.md → readme/extending-blt.md b/docs/extending-blt.md → readme/extending-blt.md
diff --git a/docs/features-workflow.md → readme/features-workflow.md b/docs/features-workflow.md → readme/features-workflow.md
diff --git a/docs/local-development.md → readme/local-development.md b/docs/local-development.md → readme/local-development.md
diff --git a/docs/onboarding.md → readme/onboarding.md b/docs/onboarding.md → readme/onboarding.md
diff --git a/docs/os-contribution.md → readme/os-contribution.md b/docs/os-contribution.md → readme/os-contribution.md
diff --git a/docs/project-tasks.md → readme/project-tasks.md b/docs/project-tasks.md → readme/project-tasks.md
diff --git a/docs/release-process.md → readme/release-process.md b/docs/release-process.md → readme/release-process.md
diff --git a/docs/repo-architecture.md → readme/repo-architecture.md b/docs/repo-architecture.md → readme/repo-architecture.md
diff --git a/docs/views.md → readme/views.md b/docs/views.md → readme/views.md