From: Tim Otten Date: Sat, 3 Oct 2015 19:03:33 +0000 (-0400) Subject: docs/ - Update navigation, file structure, requirements X-Git-Url: https://vcs.fsf.org/?a=commitdiff_plain;h=544a467782fb9750ffaa4250cfd2c036611a6d22;p=civicrm-core.git docs/ - Update navigation, file structure, requirements --- diff --git a/docs/api.md b/docs/api.md new file mode 100644 index 0000000000..adbe8ed51b --- /dev/null +++ b/docs/api.md @@ -0,0 +1,3 @@ +*The API* + +TODO: Assimilate http://wiki.civicrm.org/confluence/display/CRMDOC/Using+the+API \ No newline at end of file diff --git a/docs/build.md b/docs/build.md new file mode 100644 index 0000000000..19b91c3634 --- /dev/null +++ b/docs/build.md @@ -0,0 +1,7 @@ +*Build.md* + +TODO: + + * Nightlies vs gitify vs civibuild + * gitify + * civibuild (https://github.com/civicrm/civicrm-buildkit/blob/master/doc/civibuild.md) diff --git a/docs/customize.md b/docs/customize.md index 309f158571..c2377aa005 100644 --- a/docs/customize.md +++ b/docs/customize.md @@ -1 +1,12 @@ -# Customize \ No newline at end of file +*Customize* + +TODO: + + * *(Requirements: Don't need full git install)* + * *(When possible, link to User/Admin Guide or other existing docs instead of giving details.)* + * Custom fields, profiles, option groups, etc + * webform_civicrm + * Extensions (download+install; web and CLI). + * (Maybe) CiviRules + * (Maybe) CSS override + * (Maybe) *.extra.tpl diff --git a/docs/develop.md b/docs/develop.md index 58aafee9b4..f58af5f555 100644 --- a/docs/develop.md +++ b/docs/develop.md @@ -1 +1,3 @@ -# Develop \ No newline at end of file +*Develop* + +TODO: Assimilate http://wiki.civicrm.org/confluence/display/CRMDOC/GitHub+for+CiviCRM diff --git a/docs/extend.md b/docs/extend.md index e6521b021c..22d22a52b1 100644 --- a/docs/extend.md +++ b/docs/extend.md @@ -1 +1,7 @@ -# Extend \ No newline at end of file +*Extend* + +TODO: + + * General overview: Use APIv3 and hooks. Package code in Civi extensions or CMS extensions (w/trade-offs). + * Assimilate: http://wiki.civicrm.org/confluence/display/CRMDOC/Create+an+Extension + * Assimilate: http://wiki.civicrm.org/confluence/display/CRMDOC/Publish+an+Extension diff --git a/docs/hook.md b/docs/hook.md new file mode 100644 index 0000000000..e071122866 --- /dev/null +++ b/docs/hook.md @@ -0,0 +1,6 @@ +*The hooks* + +TODO: + + * http://wiki.civicrm.org/confluence/display/CRMDOC/Hooks + * http://wiki.civicrm.org/confluence/display/CRMDOC/Hook+Reference \ No newline at end of file diff --git a/docs/index.md b/docs/index.md index 7edcaf6f32..691fecb564 100644 --- a/docs/index.md +++ b/docs/index.md @@ -1,5 +1,9 @@ # Build +CiviCRM is an open-source application which can be poked, prodded, twisted, +and hacked. It can be customized (with minimal code skills), extended (for +add-ons and integrations), and collaboratively developed. + @@ -7,20 +11,24 @@ - - + + + + + + - - + + - - + + @@ -31,6 +39,9 @@ # Collaborate +As an open-source project, CiviCRM is managed by an international community +of developers and activists. If you have questions, issues, or want to make +plans for new development, reach out online.
Get the tools you need
DevelopCreate a feature or fix for CiviCRMGit InstallInstall the latest code from git
CustomizeChange your site without coding
Extend Create an add-on or integration
TestMake it goodDevelopCreate a feature or fix for CiviCRM
CustomizeChange your site without codingTestMake it good
Reference
@@ -40,7 +51,7 @@ - + @@ -66,6 +77,10 @@ + + + + diff --git a/docs/reference.md b/docs/reference.md deleted file mode 100644 index cf5aa07416..0000000000 --- a/docs/reference.md +++ /dev/null @@ -1 +0,0 @@ -# Reference diff --git a/docs/requirements.md b/docs/requirements.md index da801d1ceb..0fb7d13b89 100644 --- a/docs/requirements.md +++ b/docs/requirements.md @@ -25,8 +25,8 @@ 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. +In subsequent steps, the download script will attempt to identify +misconfigurations and display an appropriate message. # Buildkit @@ -39,7 +39,28 @@ 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: +a script which downloads the full collection. + +### - Option #1: Full Stack Ubuntu (Opinionated) + +If you have a new installation of Ubuntu 12.04 or 14.04, then you can download everything -- buildkit and the system +requirements (`git`, `php`, `apache`, `mysql`, etc) -- with one command. This command will install buildkit to `~/buildkit`: + +```bash +curl -Ls https://civicrm.org/get-buildkit.sh | bash -s -- --full --dir ~/buildkit +``` + +Note: + + * When executing the above command, you must ***NOT*** run as `root`. (Doing so will produce incorrect permissions.) + Instead, you must have `sudo` permissions. + * The `--full` option is opinionated; it specifically installs `php`, `apache`, and `mysql` (rather than `hvm`, `nginx`, `lighttpd`, or `percona`). + If you try to mix `--full` with alternative systems, then expect conflicts. + + +### - Option #2: Other Systems + +If you already installed the requirements (`git`, `php`, etc), then you can download buildkit to `~/buildkit` with these commands: ```bash git clone https://github.com/civicrm/civicrm-buildkit.git buildkit @@ -48,7 +69,9 @@ cd buildkit/bin export PATH="$PWD:$PATH" ``` -To update buildkit, you may wish to periodically run: +### - Option #3: Upgrade + +If you have previously downloaded buildkit and want to update it, run: ```bash cd buildkit diff --git a/docs/test.md b/docs/test.md index 21e60f8358..8d4c4ead03 100644 --- a/docs/test.md +++ b/docs/test.md @@ -1 +1,5 @@ -# Test \ No newline at end of file +*Test* + +TODO: + + * http://wiki.civicrm.org/confluence/display/CRMDOC/Testing \ No newline at end of file diff --git a/mkdocs.yml b/mkdocs.yml index 1a28d446c2..71627062bd 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -1,10 +1,15 @@ 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 + - Setup: + - Requirements: requirements.md + - Git Install: build.md + - Tutorial: + - Customize: customize.md + - Extend: extend.md + - Develop: develop.md + - Test: test.md + - Reference: + - 'APIv3': api.md + - 'Hooks': hook.md theme: readthedocs
ForumReach out to Civi's worldwide developer communityConverse in the public square
GithubSprints Get together IRL
StackExchangeAsk questions. Find answers.
Wiki Share drafts, notes, and specs