From 63cae42bdcbe3f06fb619c5ce0c235b792509181 Mon Sep 17 00:00:00 2001 From: Matthew Grasmick Date: Tue, 9 Aug 2016 15:27:59 -0400 Subject: [PATCH] Moving docs to readme. --- INSTALL.md | 8 ++++---- README.md | 4 ++-- mkdocs.yml | 26 +++++++++++++------------- {docs => readme}/acsf-setup.md | 0 {docs => readme}/architecture.md | 0 {docs => readme}/best-practices.md | 0 {docs => readme}/ci.md | 0 {docs => readme}/code-review.md | 0 {docs => readme}/deploy.md | 0 {docs => readme}/dev-workflow.md | 0 {docs => readme}/examples/readme.md | 0 {docs => readme}/extending-blt.md | 0 {docs => readme}/features-workflow.md | 0 {docs => readme}/local-development.md | 0 {docs => readme}/onboarding.md | 0 {docs => readme}/os-contribution.md | 0 {docs => readme}/project-tasks.md | 0 {docs => readme}/release-process.md | 0 {docs => readme}/repo-architecture.md | 0 {docs => readme}/views.md | 0 20 files changed, 19 insertions(+), 19 deletions(-) rename {docs => readme}/acsf-setup.md (100%) rename {docs => readme}/architecture.md (100%) rename {docs => readme}/best-practices.md (100%) rename {docs => readme}/ci.md (100%) rename {docs => readme}/code-review.md (100%) rename {docs => readme}/deploy.md (100%) rename {docs => readme}/dev-workflow.md (100%) rename {docs => readme}/examples/readme.md (100%) rename {docs => readme}/extending-blt.md (100%) rename {docs => readme}/features-workflow.md (100%) rename {docs => readme}/local-development.md (100%) rename {docs => readme}/onboarding.md (100%) rename {docs => readme}/os-contribution.md (100%) rename {docs => readme}/project-tasks.md (100%) rename {docs => readme}/release-process.md (100%) rename {docs => readme}/repo-architecture.md (100%) rename {docs => readme}/views.md (100%) diff --git a/INSTALL.md b/INSTALL.md index 43c90271d..0c7c90bff 100644 --- 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 index 996440e28..5c75fb77c 100644 --- 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 index 80bb66e05..9644444d5 100644 --- 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 b/readme/acsf-setup.md similarity index 100% rename from docs/acsf-setup.md rename to readme/acsf-setup.md diff --git a/docs/architecture.md b/readme/architecture.md similarity index 100% rename from docs/architecture.md rename to readme/architecture.md diff --git a/docs/best-practices.md b/readme/best-practices.md similarity index 100% rename from docs/best-practices.md rename to readme/best-practices.md diff --git a/docs/ci.md b/readme/ci.md similarity index 100% rename from docs/ci.md rename to readme/ci.md diff --git a/docs/code-review.md b/readme/code-review.md similarity index 100% rename from docs/code-review.md rename to readme/code-review.md diff --git a/docs/deploy.md b/readme/deploy.md similarity index 100% rename from docs/deploy.md rename to readme/deploy.md diff --git a/docs/dev-workflow.md b/readme/dev-workflow.md similarity index 100% rename from docs/dev-workflow.md rename to readme/dev-workflow.md diff --git a/docs/examples/readme.md b/readme/examples/readme.md similarity index 100% rename from docs/examples/readme.md rename to readme/examples/readme.md diff --git a/docs/extending-blt.md b/readme/extending-blt.md similarity index 100% rename from docs/extending-blt.md rename to readme/extending-blt.md diff --git a/docs/features-workflow.md b/readme/features-workflow.md similarity index 100% rename from docs/features-workflow.md rename to readme/features-workflow.md diff --git a/docs/local-development.md b/readme/local-development.md similarity index 100% rename from docs/local-development.md rename to readme/local-development.md diff --git a/docs/onboarding.md b/readme/onboarding.md similarity index 100% rename from docs/onboarding.md rename to readme/onboarding.md diff --git a/docs/os-contribution.md b/readme/os-contribution.md similarity index 100% rename from docs/os-contribution.md rename to readme/os-contribution.md diff --git a/docs/project-tasks.md b/readme/project-tasks.md similarity index 100% rename from docs/project-tasks.md rename to readme/project-tasks.md diff --git a/docs/release-process.md b/readme/release-process.md similarity index 100% rename from docs/release-process.md rename to readme/release-process.md diff --git a/docs/repo-architecture.md b/readme/repo-architecture.md similarity index 100% rename from docs/repo-architecture.md rename to readme/repo-architecture.md diff --git a/docs/views.md b/readme/views.md similarity index 100% rename from docs/views.md rename to readme/views.md