Skip to content
Snippets Groups Projects
Commit 40241cae authored by Seamus Lee's avatar Seamus Lee
Browse files

Reorder requirements docs into the basics section and move devloping civicrm...

Reorder requirements docs into the basics section and move devloping civicrm into core and add backdrop in
parent 4f01f5c4
Branches
No related tags found
No related merge requests found
......@@ -43,46 +43,4 @@ but that takes a lot of work.
[civicrm-buildkit](https://github.com/civicrm/civicrm-buildkit) provides
a script which downloads the full collection.
### Installing buildkit on Ubuntu
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.
### Installing buildkit on 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"
```
### Upgrading buildkit
If you have previously downloaded buildkit and want to update it, run:
```bash
cd buildkit
git pull
./bin/civi-download-tools
```
The developer docs have mode information on installing and upgrading [buildkit](https://docs.civicrm.org/dev/en/stable/tools/buildkit/).
......@@ -5,7 +5,7 @@ This chapter provides a general overview of the codebase organisation.
!!! tip
In order to explore the directories inside the CiviCRM repository it is
generally quickest to to make a local clone of the CiviCRM from GitHub,
or better yet install the [buildkit](/requirements.md#buildkit).
or better yet install the [buildkit](/basics/requirements.md#buildkit).
!!! tip
The CiviCRM codebase is object oriented. If you aren't familiar with object
......
......@@ -17,6 +17,8 @@ shell scripts, Drush & Drush make, or composer). The repositories are:
Joomla integration modules.
- [civicrm-wordpress](https://github.com/civicrm/civicrm-wordpress/) -
WordPress integration modules.
- [civicrm-backdrop](https://github.com/civicrm/civicrm-backdrop/) -
Backdrop integration module.
- [civicrm-packages](https://github.com/civicrm/civicrm-packages/) -
External dependencies required by CiviCRM.
- [civicrm-l10n](https://github.com/civicrm/civicrm-l10n/) -
......
......@@ -8,6 +8,7 @@ pages:
- Home: index.md
- Basics:
- Developer Community: basics/community.md
- Requirements: basics/requirements.md
- Useful Skills: basics/skills.md
- Planning Your Project: basics/planning.md
- File System: basics/filesystem.md
......@@ -22,6 +23,7 @@ pages:
- Debugging: tools/debugging.md
- Core Development:
- When to Edit Core: core/hacking.md
- Developing CiviCRM: core/develop.md
- How to Contribute: core/contributing.md
- Reviewing PR's: core/pr-review.md
- Codebase & Architecture: core/architecture.md
......@@ -215,9 +217,6 @@ pages:
- Documenting Extensions: documentation/extensions.md
- Markdown: documentation/markdown.md
- Style Guide: documentation/style-guide.md
- Content to reorganize:
- Requirements: requirements.md
- Develop: develop.md
markdown_extensions:
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment