From: Tim Otten Date: Mon, 14 Sep 2015 00:23:19 +0000 (-0700) Subject: Add skeletal "docs" X-Git-Url: https://vcs.fsf.org/?a=commitdiff_plain;h=6ac045aa9ddec5037b911904c032b1231d44cae2;p=civicrm-core.git Add skeletal "docs" --- diff --git a/docs/customize.md b/docs/customize.md new file mode 100644 index 0000000000..309f158571 --- /dev/null +++ b/docs/customize.md @@ -0,0 +1 @@ +# Customize \ No newline at end of file diff --git a/docs/develop.md b/docs/develop.md new file mode 100644 index 0000000000..58aafee9b4 --- /dev/null +++ b/docs/develop.md @@ -0,0 +1 @@ +# Develop \ No newline at end of file diff --git a/docs/extend.md b/docs/extend.md new file mode 100644 index 0000000000..e6521b021c --- /dev/null +++ b/docs/extend.md @@ -0,0 +1 @@ +# Extend \ No newline at end of file diff --git a/docs/index.md b/docs/index.md new file mode 100644 index 0000000000..7edcaf6f32 --- /dev/null +++ b/docs/index.md @@ -0,0 +1,74 @@ +# Build + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
RequirementsGet the tools you need
DevelopCreate a feature or fix for CiviCRM
ExtendCreate an add-on or integration
TestMake it good
CustomizeChange your site without coding
ReferenceDig into the nitty-gritty
+ +# Collaborate + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
BlogRead about the big developments
ForumReach out to Civi's worldwide developer community
GithubTap the firehose of core development
GuidelinesCheck the rules of the road
IRCChat with other developers in real-time
IssuesDiscover on-going and resolved issues
PublishShare your extensions
SprintsGet together IRL
WikiShare drafts, notes, and specs
diff --git a/docs/reference.md b/docs/reference.md new file mode 100644 index 0000000000..cf5aa07416 --- /dev/null +++ b/docs/reference.md @@ -0,0 +1 @@ +# Reference diff --git a/docs/requirements.md b/docs/requirements.md new file mode 100644 index 0000000000..da801d1ceb --- /dev/null +++ b/docs/requirements.md @@ -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 index 0000000000..21e60f8358 --- /dev/null +++ b/docs/test.md @@ -0,0 +1 @@ +# Test \ No newline at end of file diff --git a/mkdocs.yml b/mkdocs.yml new file mode 100644 index 0000000000..1a28d446c2 --- /dev/null +++ b/mkdocs.yml @@ -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