The OroPlatform and OroCRM documentation.
Clone or download
DariaHanzenko and kisakova DOC-999: Update Installation Recommendations (#20873) (#20885)
* DOC-986: Reviewed

* DOC-999: Updated Installation Recommendations

* DOC-999: Updated

* DOC-999: peer-review
Latest commit dd4e44c Nov 16, 2018
Permalink
Failed to load latest commit information.
_static/css DOC-754: Update User Role Management (#17594) Apr 11, 2018
_templates DOC-733: Cumulative update part 3. Architecture and configuration Gui… Mar 30, 2018
admin_guide DOC-986: Compare Accounts&Contacts to Customers&Customer Users (#20702) Nov 9, 2018
architecture BAP-17276: Remove mailchimp package dependency Oct 31, 2018
community DOC-872: Fixes for OroPlatform Documentation (#20148) Oct 2, 2018
dev_guide DOC-971: Smallfixes (master) (#20454) Oct 23, 2018
images/book Merge remote-tracking branch 'origin/master' into feature/BAP-11593_w… Sep 30, 2016
img DOC-990: Smallfixes include doc-972, doc-988, doc-990 (#20648) Nov 2, 2018
install_upgrade DOC-999: Update Installation Recommendations (#20873) (#20885) Nov 16, 2018
reference BAP-17728: Fix various typos Oct 15, 2018
user_guide DOC-986: Compare Accounts&Contacts to Customers&Customer Users (#20702) Nov 9, 2018
user_guide_business_intelligence DOC-954: Updated fontawesomes in commerce and crm (#20306) Oct 23, 2018
user_guide_marketing_tools BAP-17276: Remove mailchimp package dependency Oct 31, 2018
user_guide_sales_tools DOC-986: Compare Accounts&Contacts to Customers&Customer Users (#20702) Nov 9, 2018
user_guide_support_tools DOC-764: Add Missing Information for Workflows (#17733) Apr 12, 2018
.gitignore BAP-14370: Do not run any tests for PR that contains documentation ch… Mar 28, 2017
.travis.yml Update scale_nodes.rst (#7044) Jan 30, 2017
LICENSE Merge remote-tracking branch 'origin/master' into feature/BAP-11593_w… Sep 30, 2016
Makefile Merge remote-tracking branch 'origin/master' into feature/BAP-11593_w… Sep 30, 2016
README.md BAP-17728: Fix various typos Oct 15, 2018
build.xml Merge remote-tracking branch 'origin/master' into feature/BAP-11593_w… Sep 30, 2016
conf.py BAP-17728: Fix various typos Oct 15, 2018
index.rst DOC-913: Swap the Architecture Guide and Installation Guide items in … Sep 10, 2018
logsphinx.log DOC-210: Front store documentation (#11236) Jun 26, 2017
make.bat OPI-68: Updated documentation build script to use optional env var DO… Jul 4, 2017
make.sh DOC-318: Add doc about dev env best practices (#13261) Sep 15, 2017
requirements.txt DOC-991: Updated requests version (#20603) Oct 31, 2018
sphinxbuild.log DOC-821: Adjust Documentation Content for 3rd Level Menu (#18945) Jul 5, 2018
system_requirements.rst BAP-17090: Provide compatibility with PHP 7.2 (#18847) Oct 18, 2018

README.md

Oro Documentation

Oro documentation explains how to develop business application in easy and extendable way. The use of the documentation is subject to the CC-BY-NC-SA 4.0 license.

Documentation is published at https://www.oroinc.com/doc/orocrm

Documentation Structure

The Oro Book

Overview of Platform architecture, design and key features. This section will help to understand better platform design and technical details.

The Oro Cookbook

Developer guidance to specific features and implementations, collection of "How to" articles that allow to achieve result in quick and right way without going deep into technical details.

User Guide

End user oriented documentation that explains how to administer and configure platform features.

Community Guide

Learn about our development process and how you can contribute to OroPlatform.

Build Documentation in Local Environment

In Oro solutions, documentation uses reStructuredText format and could be built with Sphinx:

  1. Install pip.
  2. Install Sphinx with Extensions for PHP and Symfony using the following command:   pip install --upgrade -q -r requirements.txt
  3. Run make html in documentation folder. Ensure that conf.py (documentation build configuration file) is there.

Documentation will be available in _build/html folder.