diff --git a/docs/api.md b/docs/api.md deleted file mode 100644 index adbe8ed51bf4..000000000000 --- a/docs/api.md +++ /dev/null @@ -1,3 +0,0 @@ -*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 deleted file mode 100644 index 19b91c36348a..000000000000 --- a/docs/build.md +++ /dev/null @@ -1,7 +0,0 @@ -*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 deleted file mode 100644 index c2377aa0059c..000000000000 --- a/docs/customize.md +++ /dev/null @@ -1,12 +0,0 @@ -*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 deleted file mode 100644 index f58af5f55535..000000000000 --- a/docs/develop.md +++ /dev/null @@ -1,3 +0,0 @@ -*Develop* - -TODO: Assimilate http://wiki.civicrm.org/confluence/display/CRMDOC/GitHub+for+CiviCRM diff --git a/docs/extend.md b/docs/extend.md deleted file mode 100644 index 22d22a52b1c6..000000000000 --- a/docs/extend.md +++ /dev/null @@ -1,7 +0,0 @@ -*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 deleted file mode 100644 index e07112286619..000000000000 --- a/docs/hook.md +++ /dev/null @@ -1,6 +0,0 @@ -*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 deleted file mode 100644 index 691fecb56482..000000000000 --- a/docs/index.md +++ /dev/null @@ -1,89 +0,0 @@ -# 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. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
RequirementsGet the tools you need
Git InstallInstall the latest code from git
CustomizeChange your site without coding
ExtendCreate an add-on or integration
DevelopCreate a feature or fix for CiviCRM
TestMake it good
ReferenceDig into the nitty-gritty
- -# 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. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
BlogRead about the big developments
ForumConverse in the public square
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
StackExchangeAsk questions. Find answers.
WikiShare drafts, notes, and specs
diff --git a/docs/requirements.md b/docs/requirements.md deleted file mode 100644 index 0fb7d13b89ab..000000000000 --- a/docs/requirements.md +++ /dev/null @@ -1,80 +0,0 @@ -# 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). - -In subsequent steps, the download script will attempt to identify -misconfigurations and display an appropriate message. - -# 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. - -### - 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 -cd buildkit/bin -./civi-download-tools -export PATH="$PWD:$PATH" -``` - -### - Option #3: Upgrade - -If you have previously downloaded buildkit and want to update it, run: - -```bash -cd buildkit -git pull -./bin/civi-download-tools -``` diff --git a/docs/test.md b/docs/test.md deleted file mode 100644 index 8d4c4ead03fd..000000000000 --- a/docs/test.md +++ /dev/null @@ -1,5 +0,0 @@ -*Test* - -TODO: - - * http://wiki.civicrm.org/confluence/display/CRMDOC/Testing \ No newline at end of file