From eb8e22c1ab3f63ac707a4cf558f3856f8f0d1f7a Mon Sep 17 00:00:00 2001
From: Sean Madsen <sean@seanmadsen.com>
Date: Sun, 23 Jul 2017 20:05:53 -0600
Subject: [PATCH] Buildkit - relocate "Applying a patch" content
This was in the general "buildkit" page, and I think it fits better in
the specific "civibuild" page.
---
docs/tools/buildkit.md | 16 ----------------
docs/tools/civibuild.md | 39 ++++++++++++++++++++++++++++-----------
2 files changed, 28 insertions(+), 27 deletions(-)
diff --git a/docs/tools/buildkit.md b/docs/tools/buildkit.md
index ad7e91d0..968238e6 100644
--- a/docs/tools/buildkit.md
+++ b/docs/tools/buildkit.md
@@ -79,22 +79,6 @@ npm update
npm install fs-extra
```
-## Applying a patch
-
-Using buildkit, you can create a CiviCRM environment with the PR applied.
-
-For example:
-
-```bash
-civibuild create dmaster \
- --url http://localhost:8001 \
- --patch https://github.com/civicrm/civicrm-core/pull/8494 \
- --admin-pass s3cr3t
-```
-
-This will create a test environment with the Drupal, CiviCRM master branch
-and the patch in PR 8494. More detailed information is in the
-[Civibuild documentation](https://github.com/civicrm/civicrm-buildkit/blob/master/doc/civibuild.md)
## Post-install configuration {:#configuring}
diff --git a/docs/tools/civibuild.md b/docs/tools/civibuild.md
index 9b1cad40..a9caa6fa 100644
--- a/docs/tools/civibuild.md
+++ b/docs/tools/civibuild.md
@@ -274,21 +274,26 @@ vi app/civibuild.conf
The template includes documentation and examples.
-## Development/Testing of `civibuild` {:#development}
-The tests for `civibuild` are stored in `tests/phpunit`. These are
-integration tests which create and destroy real builds on the local system.
-To run them:
+## Examples
-* Configure `amp` (as above)
-* Ensure that a test site is configured (`civibuild create civibild-test --type empty`)
-* Run `phpunit4` or `env DEBUG=1 OFFLINE=1 phpunit4`
- * Note that the tests accept some optional environment variables:
- * `DEBUG=1` - Display command output as it runs
- * `OFFLINE=1` - Try to avoid unnecessary network traffic
+### Applying a patch
+
+Using buildkit, you can create a CiviCRM environment with the PR applied.
+For example:
+
+```bash
+civibuild create dmaster \
+ --url http://localhost:8001 \
+ --patch https://github.com/civicrm/civicrm-core/pull/8494 \
+ --admin-pass s3cr3t
+```
-## Experimental: Multiple demo/training sites {:#demo-training}
+This will create a test environment with the Drupal, CiviCRM master branch
+and the patch in PR 8494.
+
+### Experimental: Multiple demo/training sites {:#demo-training}
When creating a batch of identical sites for training or demonstrations,
one may want to create a single source-code-build with several
@@ -317,6 +322,18 @@ $ for num in $(seq -w 1 20) ; do
done
```
+## Development/Testing of `civibuild` {:#development}
+
+The tests for `civibuild` are stored in `tests/phpunit`. These are
+integration tests which create and destroy real builds on the local system.
+To run them:
+
+* Configure `amp` (as above)
+* Ensure that a test site is configured (`civibuild create civibild-test --type empty`)
+* Run `phpunit4` or `env DEBUG=1 OFFLINE=1 phpunit4`
+ * Note that the tests accept some optional environment variables:
+ * `DEBUG=1` - Display command output as it runs
+ * `OFFLINE=1` - Try to avoid unnecessary network traffic
## Credits
--
GitLab