Add skeletal "docs"
authorTim Otten <totten@civicrm.org>
Mon, 14 Sep 2015 00:23:19 +0000 (17:23 -0700)
committerTim Otten <totten@civicrm.org>
Mon, 5 Oct 2015 13:23:52 +0000 (14:23 +0100)
docs/customize.md [new file with mode: 0644]
docs/develop.md [new file with mode: 0644]
docs/extend.md [new file with mode: 0644]
docs/index.md [new file with mode: 0644]
docs/reference.md [new file with mode: 0644]
docs/requirements.md [new file with mode: 0644]
docs/test.md [new file with mode: 0644]
mkdocs.yml [new file with mode: 0644]

diff --git a/docs/customize.md b/docs/customize.md
new file mode 100644 (file)
index 0000000..309f158
--- /dev/null
@@ -0,0 +1 @@
+# Customize
\ No newline at end of file
diff --git a/docs/develop.md b/docs/develop.md
new file mode 100644 (file)
index 0000000..58aafee
--- /dev/null
@@ -0,0 +1 @@
+# Develop
\ No newline at end of file
diff --git a/docs/extend.md b/docs/extend.md
new file mode 100644 (file)
index 0000000..e6521b0
--- /dev/null
@@ -0,0 +1 @@
+# Extend
\ No newline at end of file
diff --git a/docs/index.md b/docs/index.md
new file mode 100644 (file)
index 0000000..7edcaf6
--- /dev/null
@@ -0,0 +1,74 @@
+# Build
+
+<table>
+  <tbody>
+    <tr>
+      <td><a href="requirements">Requirements</a></td>
+      <td>Get the tools you need</td>
+    </tr>
+    <tr>
+      <td><a href="develop">Develop</a></td>
+      <td>Create a feature or fix for CiviCRM</td>
+    </tr>
+    <tr>
+      <td><a href="extend">Extend</a></td>
+      <td>Create an add-on or integration</td>
+    </tr>
+    <tr>
+      <td><a href="test">Test</a></td>
+      <td>Make it good</td>
+    </tr>
+    <tr>
+      <td><a href="customize">Customize</a></td>
+      <td>Change your site without coding</td>
+    </tr>
+    <tr>
+      <td><a href="reference">Reference</a></td>
+      <td>Dig into the nitty-gritty</td>
+    </tr>
+  </tbody>
+</table>
+
+# Collaborate
+
+
+<table>
+  <tbody>
+    <tr>
+      <td><a href="https://civicrm.org/blog">Blog</a></td>
+      <td>Read about the big developments</td>
+    </tr>
+    <tr>
+      <td><a href="http://forum.civicrm.org/">Forum</a></td>
+      <td>Reach out to Civi's worldwide developer community</td>
+    </tr>
+    <tr>
+      <td><a href="https://github.com/civicrm/civicrm-core/">Github</a></td>
+      <td>Tap the firehose of core development</td>
+    </tr>
+    <tr>
+      <td><a href="FIXME">Guidelines</a></td>
+      <td>Check the rules of the road</td>
+    </tr>
+    <tr>
+      <td><a href="https://irc.civicrm.org/">IRC</a></td>
+      <td>Chat with other developers in real-time</td>
+    </tr>
+    <tr>
+      <td><a href="http://issues.civicrm.org/">Issues</a></td>
+      <td>Discover on-going and resolved issues</td>
+    </tr>
+    <tr>
+      <td><a href="FIXME">Publish</a></td>
+      <td>Share your extensions</td>
+    </tr>
+    <tr>
+      <td><a href="FIXME">Sprints</a></td>
+      <td>Get together IRL</td>
+    </tr>
+    <tr>
+      <td><a href="http://wiki.civicrm.org/confluence/display/CRM/CiviCRM+Wiki">Wiki</a></td>
+      <td>Share drafts, notes, and specs</td>
+    </tr>
+  </tbody>
+</table>
diff --git a/docs/reference.md b/docs/reference.md
new file mode 100644 (file)
index 0000000..cf5aa07
--- /dev/null
@@ -0,0 +1 @@
+# Reference
diff --git a/docs/requirements.md b/docs/requirements.md
new file mode 100644 (file)
index 0000000..da801d1
--- /dev/null
@@ -0,0 +1,57 @@
+# Languages and Services
+
+ * Unix-like environment (Linux, OS X, or a virtual machine)
+ * [PHP v5.3+](http://php.net/)
+ * [MySQL v5.1+](http://mysql.com/)
+ * [NodeJS](https://nodejs.org/)
+ * [Git](https://git-scm.com/)
+ * Recommended: Apache HTTPD v2.2+
+ * Recommended: Ruby/Rake
+
+# Command Line
+
+There are many ways to install MySQL, PHP, and other dependencies -- for
+example, `apt-get` and `yum` can download packages automatically; `php.net`
+and `mysql.com` provide standalone installers; and MAMP/XAMPP provide
+bundled installers.
+
+Civi development should work with most packages -- but there's one proviso:
+***the command-line must support standard commands*** (`php`, `mysql`,
+`node`, `git`, `bash`, etc).
+
+Some packages are configured properly out-of-the-box. (Linux distributions
+do a pretty good job of this.) Other packages require extra configuration
+steps (e.g.  [Setup Command Line
+PHP](http://wiki.civicrm.org/confluence/display/CRMDOC/Setup+Command-Line+PHP)
+for MAMP).
+
+If the command-line is misconfigured, the command `civi-download-tools`
+(below) will attempt to display an appropriate warning.
+
+# Buildkit
+
+The developer docs reference a large number of developer tools, such as
+`drush` (the Drupal command line), `civix` (the CiviCRM code-generator), and
+`karma` (the Javascript tester).
+
+Many of these tools are commonly used by web developers, so you may have
+already installed a few.  You could install all the tools individually --
+but that takes a lot of work.
+
+[civicrm-buildkit](https://github.com/civicrm/civicrm-buildkit) provides
+a script which downloads the full collection:
+
+```bash
+git clone https://github.com/civicrm/civicrm-buildkit.git buildkit
+cd buildkit/bin
+./civi-download-tools
+export PATH="$PWD:$PATH"
+```
+
+To update buildkit, you may wish to periodically run:
+
+```bash
+cd buildkit
+git pull
+./bin/civi-download-tools
+```
diff --git a/docs/test.md b/docs/test.md
new file mode 100644 (file)
index 0000000..21e60f8
--- /dev/null
@@ -0,0 +1 @@
+# Test
\ No newline at end of file
diff --git a/mkdocs.yml b/mkdocs.yml
new file mode 100644 (file)
index 0000000..1a28d44
--- /dev/null
@@ -0,0 +1,10 @@
+site_name: CiviCRM Development
+pages:
+ - Introduction: index.md
+ - Requirements: requirements.md
+ - Develop: develop.md
+ - Extend: extend.md
+ - Test: test.md
+ - Customize: customize.md
+ - Reference: reference.md
+theme: readthedocs