[Pkg-owncloud-commits] [owncloud-doc] 30/44: Added development environment chapter
David Prévot
taffit at moszumanska.debian.org
Sun Dec 15 00:06:48 UTC 2013
This is an automated email from the git hooks/post-receive script.
taffit pushed a commit to branch dfsg_clean
in repository owncloud-doc.
commit edf3629437ae64b88c86c5a4128ccbb6ac6227f9
Author: Vincent Petry <PVince81 at yahoo.fr>
Date: Wed Dec 11 15:31:59 2013 +0100
Added development environment chapter
Moved "Getting started" instructions into a separate
"Development Environment" section.
Added more steps to clarify.
---
developer_manual/app/app/static.rst | 2 +-
developer_manual/app/index.rst | 8 +-
developer_manual/app/intro/gettingstarted.rst | 73 ------------------
developer_manual/app/intro/index.rst | 1 -
developer_manual/contents.rst | 1 +
developer_manual/devenv/index.rst | 105 ++++++++++++++++++++++++++
6 files changed, 114 insertions(+), 76 deletions(-)
diff --git a/developer_manual/app/app/static.rst b/developer_manual/app/app/static.rst
index 5dce5a1..acbe4ed 100644
--- a/developer_manual/app/app/static.rst
+++ b/developer_manual/app/app/static.rst
@@ -14,5 +14,5 @@ Because ownCloud templates do not support template inheritance it is not possibl
If you use Twig Templates, there is the **script** and **style** function, see :doc:`../appframework/templates`.
-CSS and JavaScript are compressed by ownCloud so if the CSS or JavaScript do not seem to get updated, check if the debug mode is enabled. To enable it see :doc:`../intro/gettingstarted`
+CSS and JavaScript are compressed by ownCloud so if the CSS or JavaScript do not seem to get updated, check if the debug mode is enabled. To enable it see :ref:`debugmode`
diff --git a/developer_manual/app/index.rst b/developer_manual/app/index.rst
index 7761ad0..3e65ef8 100644
--- a/developer_manual/app/index.rst
+++ b/developer_manual/app/index.rst
@@ -15,6 +15,13 @@ App Developement
Intro
-----
+
+Before you start, please check if there already is a `similar app <http://apps.owncloud.com>`_ you could contribute to. Also, feel free to communicate your idea and plans to the `mailing list <https://mail.kde.org/mailman/listinfo/owncloud>`_ so other contributors might join in.
+
+Then, please make sure you have set up a development environment:
+
+* :ref:`devenv`
+
Before starting to write an app please read the security and coding guidelines:
* :doc:`general/security`
@@ -22,7 +29,6 @@ Before starting to write an app please read the security and coding guidelines:
After this you can start to write your app:
-* :doc:`intro/gettingstarted`
* :doc:`intro/createapp`
App Development using ownCloud App API
diff --git a/developer_manual/app/intro/gettingstarted.rst b/developer_manual/app/intro/gettingstarted.rst
deleted file mode 100644
index d579f3a..0000000
--- a/developer_manual/app/intro/gettingstarted.rst
+++ /dev/null
@@ -1,73 +0,0 @@
-Getting Started
-===============
-
-.. sectionauthor:: Bernhard Posselt <nukeawhale at gmail.com>
-
-Before you start, please check if there already is a `similar app <http://apps.owncloud.com>`_ you could contribute to. Also, feel free to communicate your idea and plans to the `mailing list <https://mail.kde.org/mailman/listinfo/owncloud>`_ so other contributors might join in.
-
-This tutorial uses the App Framework app, a small framework that makes developing apps easier. To use it, it has to be enabled on the apps settings page.
-
-
-Get the sources
----------------
-There are two ways to obtain ownCloud:
-
-* Using the stable version
-* Using the developement version from `GitHub`_
-
-Using stable
-~~~~~~~~~~~~
-`Install the current version of ownCloud <http://doc.owncloud.org/server/5.0/admin_manual/installation.html>`_.
-
-Using development version (recommended)
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-
-First `set up your webserver and database <http://doc.owncloud.org/server/5.0/admin_manual/installation.html>`_ (**Section**: Manual Installation - Prerequisites).
-
-ownCloud's source is hosted on `GitHub`_. To be able to participate or check out the code You will have to sign up on `GitHub`_ and install Git. For help on git, contact the `GitHub Help Page`_.
-
-To get started the basic git repositories need to cloned into the webserver's directory. Depending on the distro this will either be
-
-* **/var/www**
-* **/var/www/html**
-* **/srv/http**
-
-and the apache user and group for the **chown** command will either be
-
-* **http**
-* **www-data**
-* **apache**
-
-.. code-block:: bash
-
- sudo chmod o+rw /var/www
- cd /var/www
- git clone https://github.com/owncloud/core.git owncloud
- git clone https://github.com/owncloud/apps.git apps
- cd owncloud/
- git submodule init
- git submodule update
- mkdir data
- sudo chown -R www-data:www-data config/
- sudo chown -R www-data:www-data data/
- sudo chown -R www-data:www-data apps/
- sudo chmod -R o-rw /var/www
-
-Now restart the apache server and get ready to `set up ownCloud`_ at http://localhost/owncloud.
-
-Enable debugging mode
----------------------
-.. note:: Do not enable this for production! This can create security problems and is only meant for debugging and development!
-
-To disable JavaScript and CSS caching debugging has to be enabled in :file:`owncloud/config/config.php` by adding this to the end of the file::
-
- DEFINE('DEBUG', true);
-
-
-This is often overwritten after a **git pull** from core. Always check :file:`owncloud/config/config.php` afterwards.
-
-.. _GitHub: https://github.com/owncloud
-.. _GitHub Help Page: https://help.github.com/
-.. _set up ownCloud: http://doc.owncloud.org/server/5.0/admin_manual/installation.html
-
-
diff --git a/developer_manual/app/intro/index.rst b/developer_manual/app/intro/index.rst
index ad2528f..bc3a093 100644
--- a/developer_manual/app/intro/index.rst
+++ b/developer_manual/app/intro/index.rst
@@ -5,5 +5,4 @@ App Developement Intro
.. toctree::
:maxdepth: 1
- gettingstarted
createapp
diff --git a/developer_manual/contents.rst b/developer_manual/contents.rst
index be9a5b1..8089411 100644
--- a/developer_manual/contents.rst
+++ b/developer_manual/contents.rst
@@ -12,6 +12,7 @@ ownCloud documentation contents
.. toctree::
:maxdepth: 3
+ devenv/index
app/index
core/index
testing/index
diff --git a/developer_manual/devenv/index.rst b/developer_manual/devenv/index.rst
new file mode 100644
index 0000000..d5e81bc
--- /dev/null
+++ b/developer_manual/devenv/index.rst
@@ -0,0 +1,105 @@
+.. _devenv:
+
+=======================
+Development Environment
+=======================
+
+Please follow the steps on this page to set up your development environment.
+
+Set up web server and database
+------------------------------
+
+First `set up your webserver and database <http://doc.owncloud.org/server/5.0/admin_manual/installation.html>`_ (**Section**: Manual Installation - Prerequisites).
+
+Get the source
+--------------
+
+There are two ways to obtain ownCloud sources:
+
+* Using the `stable version <http://doc.owncloud.org/server/5.0/admin_manual/installation.html>`_
+* Using the developement version from `GitHub`_ which will be explained below.
+
+To check out the source from `GitHub`_ you will need to install git (see `Setting up git <https://help.github.com/articles/set-up-git>`_ from the GitHub help)
+
+Identify the web server's directories
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+To get started the basic git repositories need to cloned into the webserver's directory. Depending on the distro this will either be
+
+* **/var/www**
+* **/var/www/html**
+* **/srv/http**
+
+Identify the user and group the web server is running as
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+and the apache user and group for the **chown** command will either be
+
+* **http**
+* **www-data**
+* **apache**
+
+Check out the code
+~~~~~~~~~~~~~~~~~~
+
+The following commands are using "/var/www" as the web server's directory and "www-data" as user name and group.
+
+.. code-block:: bash
+
+ sudo chmod o+rw /var/www
+ cd /var/www
+ git clone https://github.com/owncloud/core.git owncloud
+ git clone https://github.com/owncloud/apps.git apps
+ cd owncloud/
+ git submodule init
+ git submodule update
+ mkdir data
+ sudo chown -R www-data:www-data config/
+ sudo chown -R www-data:www-data data/
+ sudo chown -R www-data:www-data apps/
+ sudo chmod -R o-rw /var/www
+
+Now **restart the web server**.
+
+Check out code from additional apps (optional)
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+If you would like to develop on non-core apps, you can check them out into the `apps` directory as well.
+For example for the calendar, contact and notes apps:
+
+.. code-block:: bash
+
+ cd /var/www
+ git clone http://github.com/owncloud/calendar.git calendar
+ git clone http://github.com/owncloud/contact.git contact
+ git clone http://github.com/owncloud/notes.git notes
+
+Set up ownCloud
+~~~~~~~~~~~~~~~
+
+Open http://localhost/owncloud (or the corresponding URL) in your web browser to set up your instance.
+
+Start developing
+~~~~~~~~~~~~~~~~
+
+* :doc:`App Development<app/index>`
+* :doc:`Core Development<core/index>`
+
+
+.. _debugmode:
+
+Enabling debug mode
+-------------------
+.. note:: Do not enable this for production! This can create security problems and is only meant for debugging and development!
+
+To disable JavaScript and CSS caching debugging has to be enabled in :file:`owncloud/config/config.php` by adding this to the end of the file::
+
+ DEFINE('DEBUG', true);
+
+
+This is often overwritten after a **git pull** from core. Always check :file:`owncloud/config/config.php` afterwards.
+
+.. _GitHub: https://github.com/owncloud
+.. _GitHub Help Page: https://help.github.com/
+.. _set up ownCloud: http://doc.owncloud.org/server/5.0/admin_manual/installation.html
+
--
Alioth's /usr/local/bin/git-commit-notice on /srv/git.debian.org/git/pkg-owncloud/owncloud-doc.git
More information about the Pkg-owncloud-commits
mailing list