Skip to content
Snippets Groups Projects
Commit b4a573e9 authored by Sean Madsen's avatar Sean Madsen Committed by GitHub
Browse files

Merge pull request #77 from civicrm/page-tree

New page tree
parents ae02eeb8 bb0c141d
No related branches found
No related tags found
No related merge requests found
# Building CiviCRM
TODO:
- Nightlies vs gitify vs civibuild
- gitify
- civibuild (https://github.com/civicrm/civicrm-buildkit/blob/master/doc/civibuild.md)
# Customizing CiviCRM
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
# Deprecated developer instructions
These instructions are for historical reference only, but may be of use if the newer processes don't suit your working environment.
## Deprecated: Manual checkout from Github
Steps:
* Perform a standard CiviCRM install from tarball
* Use the "gitify" command to replace the codebase with the latest code from git.
Obtain the existing CiviCRM directory (such as `/var/www/drupal/sites/all/modules/civicrm` or `/home/myuser/src/civicrm`), then run the `gitify` command. You will need to adapt the command arguments, but a typical case would be:
cd /tmp
wget https://github.com/civicrm/civicrm-core/raw/master/bin/gitify
bash gitify Drupal git://github.com/civicrm /var/www/drupal/sites/all/modules/civicrm --hooks
If you develop for multi-CMS, then you might have one copy of CiviCRM (e.g. `/home/myuser/src/civicrm`) shared by each CMS. You can use `gitify` to setup this directory, and then use symlinks to share among CMSs:
## Create ~/src/civicrm
mkdir -p ~/src/civicrm
wget https://github.com/civicrm/civicrm-core/raw/master/bin/gitify
bash gitify all git://github.com/civicrm ~/src/civicrm --l10n --hooks
## Replace an old symlink with new symlink
rm /var/www/drupal7/sites/all/modules/civicrm
ln -s ~/src/civicrm /var/www/drupal7/sites/all/modules/civicrm
## References
* [Wiki: GitHub For CiviCRM](https://wiki.civicrm.org/confluence/display/CRMDOC43/GitHub+for+CiviCRM)
# Creating CiviCRM Extensions
This page is moving. See [writing extensions](/extensions/basics).
<!--
TODO:
- delete this page after redirection in place
-->
Coming soon!
Coming soon!
Coming soon!
Coming soon!
Coming soon!
Coming soon!
Coming soon!
Coming soon!
Coming soon!
Coming soon!
...@@ -11,52 +11,70 @@ markdown_extensions: ...@@ -11,52 +11,70 @@ markdown_extensions:
pages: pages:
- Home: index.md - Home: index.md
- Basics: - Basics:
- Developer Community: basics/community.md - Developer Community: basics/community.md # page-tree = DONE
- Prerequisite skills: basics/skills.md - Useful Skills: basics/skills.md # page-tree = DONE
- Requirements: requirements.md - Planning Your Project: basics/planning.md # page-tree = DONE
- Planning your project: basics/planning.md - Documentation:
- Build: build.md - Writing Documentation: documentation.md # page-tree = NEED_PAGE_MOVE to /documentation/writing.md
- Customize: customize.md - Markdown: markdownrules.md # page-tree = NEED_PAGE_MOVE to /documentation/markdown.md
- Extend: extend.md - Style Guide: best-practices/documentation-style-guide.md # page-tree = NEED_PAGE_MOVE to /documentation/style-guide.md
- Develop: develop.md - Setup:
- Testing: testing.md # buildkit: /setup/buildkit.md # page-tree = NEED_NEW_PAGE # summary: See Github README for download instructions. Alternatively, follow links and install particular tools as-needed.
- Writing Documentation: documentation.md - Debugging: dev-tools/debugging.md # page-tree = NEED_PAGE_MOVE to /setup/debugging.md
- Development Environment: - Core Development:
- Debugging: dev-tools/debugging.md - When to edit core: core/hacking.md # page-tree = NEED_PAGE_MOVE to /core/deciding.md
- APIv3: # How to Contribute: /core/contributing.md # page-tree = NEED_NEW_PAGE # summary: General summary of process (git+issues+PRs+Mattermost)
- API Intro: api/general.md - Codebase & Architecture: core/architecture.md # page-tree = DONE
- API Usage: api/usage.md # Reporting Bugs & Issues: /core/reporting.md # page-tree = NEED_NEW_PAGE
- API Actions: api/actions.md # Submitting a Patch: /core/patches.md # page-tree = NEED_NEW_PAGE
- API Parameters: api/params.md # Review Process: /core/review.md # page-tree = NEED_NEW_PAGE # summary: Detailed guidance on how to review PRs
# Verifying a Bug Fix: /core/verifying.md # page-tree = NEED_NEW_PAGE
- API:
- API Intro: api/general.md # page-tree = DONE
- API Usage: api/usage.md # page-tree = DONE
- API Actions: api/actions.md # page-tree = DONE
- API Parameters: api/params.md # page-tree = DONE
# API Permissions: api/permissions.md # page-tree = NEED_NEW_PAGE
- API Chaining: api/chaining.md - API Chaining: api/chaining.md
# API Changes: api/changes.md # page-tree = NEED_NEW_PAGE
- Extensions Development:
- Basics: extensions/basics.md # page-tree = DONE
- civix: extensions/civix.md # page-tree = DONE
# Creating Pages: extensions/create-page.md # page-tree = NEED_NEW_PAGE
# Storing Configuration: extensions/config.md # page-tree = NEED_NEW_PAGE
# Storing Data: extensions/storing-data.md # page-tree = NEED_NEW_PAGE
# Setting Permissions: extensions/permissions.md # page-tree = NEED_NEW_PAGE
# Adding API Functions: extensions/api.md # page-tree = NEED_NEW_PAGE
# Reports: extensions/reports.md # page-tree = NEED_NEW_PAGE
# Searches: extensions/searches.md # page-tree = NEED_NEW_PAGE
# Payment Processors: extensions/payment-processors.md # page-tree = NEED_NEW_PAGE
- Publishing Extensions: extensions/publish.md # page-tree = DONE
- Extension Lifecycle: extend-stages.md # page-tree = NEED_PAGE_MOVE to /extensions/lifecycle.md
- Troubleshooting: extensions/troubleshooting.md # page-tree = DONE
- Advanced patterns: extensions/advanced.md
# Framework Reference:
# Bootstrap: /framework/bootstrap.md # page-tree = NEED_NEW_PAGE
# Cache: /framework/cache.md # page-tree = NEED_NEW_PAGE
# Components: /framework/components.md # page-tree = NEED_NEW_PAGE
# Database: /framework/database.md # page-tree = NEED_NEW_PAGE
# Resources: /framework/resources.md # page-tree = NEED_NEW_PAGE
# Upgrade: /framework/upgrade.md # page-tree = NEED_NEW_PAGE
# Code Standards:
# PHP: /standards/php.md # page-tree = NEED_NEW_PAGE
# Javascript: /standards/js.md # page-tree = NEED_NEW_PAGE
# API: /standards/api.md # page-tree = NEED_NEW_PAGE
# Git: /standards/git.md # page-tree = NEED_NEW_PAGE
# Testing:
# Testing: /testing/testing.md # page-tree = NEED_NEW_PAGE
# Other Reference:
# CiviMail: /reference/civimail.md # page-tree = NEED_NEW_PAGE
# CiviReport: /reference/civireport.md # page-tree = NEED_NEW_PAGE
# Payment Processing: /reference/payment.md # page-tree = NEED_NEW_PAGE
- Hooks: - Hooks:
- How to Use Hooks: hook.md - Using hooks: hook.md # page-tree = NEED_PAGE_MOVE to /hooks/usage.md
- All Available Hooks: hooks-db.md - MISC TO REORGANIZE OR DELETE:
- Writing Extensions: - Extensions files: extensions/files.md
- Basics: extensions/basics.md - Some of the hooks: hooks-db.md
- Using civix: extensions/civix.md - Requirements: requirements.md
- Anatomy of Files: extensions/files.md - Develop: develop.md
- Advanced Patterns: extensions/advanced.md - hookref-old: hookref-old.md
- Troubleshooting: extensions/troubleshooting.md
# - Using hooks: extensions/using-hooks.md
# - Customizing Screens: extensions/customize-screens.md
# - Creating Pages: Forms/extensions/create-page.md
# - Storing Configuration: extensions/config.md
# - Storing Data: extensions/storing-data.md
# - Setting Permissions: extensions/permissions.md
# - Custom API Functions: extensions/custom-api.md
# - Custom Reports: extensions/custom-reports.md
# - Custom Searches: extensions/custom-searches.md
# - Payment Processors: extensions/payment-processor.md
- Publish: extensions/publish.md
- Best Practices:
- Documentation Style Guide: best-practices/documentation-style-guide.md
- Core code:
- Hacking the core: core/hacking.md
- Architecture: core/architecture.md
- Miscellaneous:
- Extension Lifecycle: extend-stages.md
- Markdown: markdownrules.md
# - hookref-old: hookref-old.md
- Deprecated:
- Building CiviCRM from source: develop-deprecated.md
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment