Removing docs from template.

acquia · Aug 9, 2016 · 77a8549 · 77a8549
1 parent 997228f
commit 77a8549
Show file tree

Hide file tree

Showing 23 changed files with 23 additions and 32 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](template/readme/local-development.md) for more information on setting up your \*AMP stack:
+Please see [Local Development](docs/local-development.md) for more information on setting up your \*AMP stack:
 
-* [Acquia Dev Desktop](template/readme/local-development.md#using-acquia-dev-desktop-for-blt-generated-projects)
-* [Drupal VM](template/readme/local-development.md#using-drupal-vm-for-blt-generated-projects)
-* [Other](https://github.com/acquia/blt/blob/8.x/template/readme/local-development.md#alternative-local-development-environments)
+* [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)
 
 When you have completed setting up your local \*AMP stack, double check that the following pieces of information are still correct:
 
@@ -133,4 +133,4 @@ Note that all common project tasks are executed through `blt`. For a full list o
 
 ## Next Steps
 
-Now that your new project works locally, read through the new [README.md](https://github.com/acquia/blt/blob/8.x/template/README.md) file in your project to learn how to perform common project tasks and integrate with third party tools.
+Now that your new project works locally, read through the new [README.md](https://github.com/acquia/blt/blob/8.x/template/README.md) file in your project to learn how to perform common project tasks and integrate with third party tools.
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](template/readme/project-tasks.md)
+* [Project tasks](docs/project-tasks.md)
     * Executing tests and validating code
     * Building dependencies
     * (Re)installation of Drupal
     * Production-safe artifact generation and deployment
-* [Continuous Integration](template/readme/ci.md)
+* [Continuous Integration](docs/ci.md)
     * Travis CI
     * GitHub
 

diff --git a/template/readme/acsf-setup.md → docs/acsf-setup.md b/template/readme/acsf-setup.md → docs/acsf-setup.md
diff --git a/template/readme/architecture.md → docs/architecture.md b/template/readme/architecture.md → docs/architecture.md
diff --git a/template/readme/best-practices.md → docs/best-practices.md b/template/readme/best-practices.md → docs/best-practices.md
diff --git a/template/readme/ci.md → docs/ci.md b/template/readme/ci.md → docs/ci.md
diff --git a/template/readme/code-review.md → docs/code-review.md b/template/readme/code-review.md → docs/code-review.md
diff --git a/template/readme/deploy.md → docs/deploy.md b/template/readme/deploy.md → docs/deploy.md
diff --git a/template/readme/dev-workflow.md → docs/dev-workflow.md b/template/readme/dev-workflow.md → docs/dev-workflow.md
diff --git a/template/readme/examples/readme.md → docs/examples/readme.md b/template/readme/examples/readme.md → docs/examples/readme.md
diff --git a/template/readme/extending-blt.md → docs/extending-blt.md b/template/readme/extending-blt.md → docs/extending-blt.md
diff --git a/template/readme/features-workflow.md → docs/features-workflow.md b/template/readme/features-workflow.md → docs/features-workflow.md
diff --git a/template/readme/local-development.md → docs/local-development.md b/template/readme/local-development.md → docs/local-development.md
diff --git a/template/readme/onboarding.md → docs/onboarding.md b/template/readme/onboarding.md → docs/onboarding.md
diff --git a/template/readme/os-contribution.md → docs/os-contribution.md b/template/readme/os-contribution.md → docs/os-contribution.md
diff --git a/template/readme/project-tasks.md → docs/project-tasks.md b/template/readme/project-tasks.md → docs/project-tasks.md
diff --git a/template/readme/release-process.md → docs/release-process.md b/template/readme/release-process.md → docs/release-process.md
diff --git a/template/readme/repo-architecture.md → docs/repo-architecture.md b/template/readme/repo-architecture.md → docs/repo-architecture.md
diff --git a/template/readme/views.md → docs/views.md b/template/readme/views.md → docs/views.md
diff --git a/index.md b/index.md
@@ -1,15 +1,7 @@
 [Acquia BLT (Build and Launch Tool)](https://github.com/acquia/blt) generates new Drupal projects using a standardized template derived from Acquia Professional Services' best practices.
 
 Welcome to the BLT documentation site! Please read through the [Quick Start Guide](https://github.com/acquia/blt/INSTALL.md) to get started, and then browse the rest of this project's documentation in the sidebar.
-
-# Documentation structure
-
-BLT Documentation is broken into the following top-level segments:
-
-* Overview - Information about BLT
-* Getting started - How to add BLT to your project
-* Project documentation - Templated documentation that will be added to your BLTed project. 
 
 # Contributing to BLT
-                                       
+
 Please feel free to edit any of the pages in this documentation via the 'Edit on GitHub' link at the top right. If you would like to help improve BLT, please file issues via the GitHub issue queue. See [CONTRIBUTING.md](CONTRIBUTING.md) for contribution guidelines and instructions.
diff --git a/phing/tasks/blt.xml b/phing/tasks/blt.xml
@@ -22,6 +22,7 @@
     <!-- @todo Do not overwrite structured or executable files. Instead, update them intelligently. composer.json, project.yml, settings.php, drush.wrapper etc. -->
     <exec dir="${repo.root}" command="rsync -a --no-g --no-p --update ${blt.root}/template/ ${repo.root}/ --exclude 'project.yml' --exclude 'composer.json'" logoutput="true" checkreturn="true"/>
     <exec dir="${repo.root}" command="rsync -a --no-g --no-p --update ${blt.root}/template/project.yml ${repo.root}/ --ignore-existing" logoutput="true" checkreturn="true"/>
+    <exec dir="${repo.root}" command="rsync -a --no-g --no-p --update ${blt.root}/template/README.md ${repo.root}/ --ignore-existing" logoutput="true" checkreturn="true"/>
   </target>
 
   <target name="update" depends="init, blt:update-yml, configure">

diff --git a/scripts/blt/convert-to-composer.sh b/scripts/blt/convert-to-composer.sh
@@ -48,6 +48,20 @@ if [[ $REPLY =~ ^[Yy]$ ]]; then
   echo "Removing deprecated BLT files from project."
   rm -rf build blt.sh tests/phpunit/blt
 
+  # Removing old docs.
+  rm acsf-setup.md
+  rm architecture.md
+  rm best-practices.md
+  rm deploy.md
+  rm dev-workflow.md
+  rm features-workflow.md
+  rm local-development.md
+  rm onboarding.md
+  rm project-tasks.md
+  rm release-process.md
+  rm repo-architecture.md
+  rm views.md
+
   # Install (new) alias
   echo "Installing blt alias"
   yes | ./vendor/acquia/blt/blt.sh install-alias

diff --git a/template/README.md b/template/README.md
@@ -2,22 +2,6 @@
 
 Replace this with a brief description of the ${project.human_name} project.
 
-Documentation by role:
-
-* Developer
-    * [Onboarding](readme/onboarding.md): “how do I get up and running on project work?”
-    * [Repository architecture](readme/repo-architecture.md): “how is the code organized, and why?”
-    * [Running project tasks](readme/project-tasks.md): “how do I _____ on my local machine?”
-    * [Best practices](readme/best-practices.md): "how should I write code?"
-    * [Workflow](readme/dev-workflow.md): “how do I contribute my code to this project?”
-    * [Automated testing](tests/README.md): “how do I write / run them, and why should I care?”
-* Technical Architect
-    * [Project Architecture document](readme/architecture.md)
-    * [Deploying to cloud](readme/deploy.md)
-    * [Release process](readme/release-process.md)
-    * [Setting up continuous integration](readme/ci.md)
-    * [Open source contribution](readme/os-contribution.md)
-
 ## Resources
 
 * JIRA - link me!