Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Moving docs to readme. #275

Merged
merged 1 commit into from
Aug 9, 2016
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions INSTALL.md
Original file line number Diff line number Diff line change
Expand Up @@ -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:

Expand Down
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
26 changes: 13 additions & 13 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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'
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.