Skip to content

Commit

Permalink
Updating mkdocs to fix build errors. (#266)
Browse files Browse the repository at this point in the history
  • Loading branch information
grasmash authored Aug 8, 2016
1 parent 9663005 commit d0bdfdc
Show file tree
Hide file tree
Showing 7 changed files with 9 additions and 27 deletions.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,7 @@ See [INSTALL.md](INSTALL.md) to:
* Building dependencies
* (Re)installation of Drupal
* Production-safe artifact generation and deployment
* [Continuous Integration](template/build/README.md)
* [Continuous Integration](template/readme/ci.md)
* Travis CI
* GitHub

Expand Down
6 changes: 3 additions & 3 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -11,18 +11,18 @@ markdown_extensions:
pages:
- Home: 'README.md'
- Getting Started: 'INSTALL.md'
- Project Documentation: 'template/README.md'
- Project Documentation:
- Developer:
- Onboarding: 'template/readme/onboarding.md'
- Repository architecture: 'template/readme/repo-architecture.md'
- Running project tasks: 'template/readme/project-tasks.md'
- Best practices: 'template/readme/best-practices.md'
- Workflow: 'template/readme/dev-workflow.md'
- Automated testing: 'tests/README.md'
- Automated testing: 'template/tests/README.md'
- Technical Architect:
- Project Architecture document: 'template/readme/architecture.md'
- Deploying to cloud: 'template/readme/deploy.md'
- Release process: 'template/readme/release-process.md'
- Setting up continuous integration: 'build/README.md'
- Setting up continuous integration: 'template/readme/ci.md'
- Open source contribution: 'template/readme/os-contribution.md'
- Contributing: 'CONTRIBUTING.md'
2 changes: 1 addition & 1 deletion template/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ Documentation by role:
* [Project Architecture document](readme/architecture.md)
* [Deploying to cloud](readme/deploy.md)
* [Release process](readme/release-process.md)
* [Setting up continuous integration](build/README.md#ci)
* [Setting up continuous integration](readme/ci.md)
* [Open source contribution](readme/os-contribution.md)

## Resources
Expand Down
18 changes: 0 additions & 18 deletions phing/README.md → template/readme/ci.md
Original file line number Diff line number Diff line change
@@ -1,21 +1,3 @@
# Build files

This directory contains configuration files for running common project tasks. These may be used for running tasks locally, or for running automated builds via continuous integration solutions.

This directory should not contain any test files. Those exist in the [/tests](/tests) directory.

## Build Tasks

A large number of common build tasks are provided via Phing targets. These include tasks for things like code sniffing, executing tests, building dependencies, installing Drupal, etc.

For a full list of available Phing tasks, run `blt -list` from the project's root directory.

### Executing Tasks

* For a full list of the available Phing targets, run `blt -list`
* To manually test a Phing target, run the following command matching the the following pattern: `blt <target-name>`. For example `blt validate:all`
* To run Phing directly from the binary, simply run `./bin/phing -f build/phing/build.xml <arguments>`

## <a name="ci"></a> Continuous Integration

Integration with Travis CI is included, although Phing tasks can be used with any CI tool. The default Travis CI build process is as follows:
Expand Down
2 changes: 1 addition & 1 deletion template/readme/deploy.md
Original file line number Diff line number Diff line change
Expand Up @@ -61,7 +61,7 @@ Instead of performing these deployments manually, you can enlist the help of a C

Access to Travis is already provided by Acquia PS, which makes this option appealing on a cost basis. It will automatically deploy new commits after they are merged and tests pass. However, it's somewhat insecure (you have to create an SSH key for deployments that can be accessed by any developer), and it's impossible to schedule regular deployments or perform more advanced integrations.

For more information on configuring Travis CI, see "Setting Up Travis CI for automated deployments" in [build/README.md](../build/README.md).
For more information on configuring Travis CI, see "Setting Up Travis CI for automated deployments" in [Continuous Integration](ci.md).

### Jenkins (Cloudbees)

Expand Down
2 changes: 1 addition & 1 deletion template/readme/dev-workflow.md
Original file line number Diff line number Diff line change
Expand Up @@ -88,7 +88,7 @@ This model removes the bottleneck of designated integrators, but still eliminate

## Continuous Integration

After a Pull Request has been submitted or merged, our continuous integration solution will automatically build a site artifact, install an ephemeral instance of Drupal, and execute tests against it. For more information on the build process, please see the [build directory](../build/README.md).
After a Pull Request has been submitted or merged, our continuous integration solution will automatically build a site artifact, install an ephemeral instance of Drupal, and execute tests against it. For more information on the build process, please see the [Continuous Integration documentation](ci.md).

## Deployment on Cloud

Expand Down
4 changes: 2 additions & 2 deletions template/readme/repo-architecture.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,15 +11,15 @@ The repository architecture is driven by a set of core principles:
Consequently, there are a few aspects of this project’s architecture and workflow that may be unfamiliar to you.

* Drupal core, contrib modules, themes, and third parties libraries are not committed to the repository. Contrib directories .gitignored and populated during [build artifact](deploy.md) generation.
* The repository is never pushed directly to the cloud. Instead, changes to the repository on GitHub trigger tests to be run via [Continuous Integration](../build/README.md#ci). Changes that pass testing will automatically cause a [build artifact](deploy.md) to be created and deployed to the cloud.
* The repository is never pushed directly to the cloud. Instead, changes to the repository on GitHub trigger tests to be run via [Continuous Integration](../phing/readme#ci). Changes that pass testing will automatically cause a [build artifact](deploy.md) to be created and deployed to the cloud.
* [Common project tasks](project-tasks.md) are executed via a build tool (Phing) so that they can be executed exactly the same in all circumstances.

## Directory structure

The following is an overview of the purpose of each top level directory in the project template:

root
├── build - Contains build config files for CI solutions. E.g., Phing configuration.
├── blt - Contains custom build config files for CI solutions. E.g., Phing configuration.
├── drush - Contain drush configuration that is not site or environment specific.
├── docroot - The drupal docroot.
├── hooks - Contains Acquia Cloud hooks.
Expand Down

0 comments on commit d0bdfdc

Please sign in to comment.