mirror of
https://github.com/nextcloud/documentation.git
synced 2026-01-03 02:09:45 +07:00
finished structuring
This commit is contained in:
Bernhard Posselt
18
developer_manual/app/app/index.rst
Normal file
18
developer_manual/app/app/index.rst
Normal file
@@ -0,0 +1,18 @@
|
||||
===========================================
|
||||
App Developement Using the ownCloud App API
|
||||
===========================================
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 1
|
||||
|
||||
tutorial
|
||||
info
|
||||
schema
|
||||
database
|
||||
static
|
||||
css
|
||||
javascript
|
||||
externalapi
|
||||
filesystem
|
||||
hooks
|
||||
data-migration
|
||||
@@ -1,21 +0,0 @@
|
||||
.. _contents:
|
||||
|
||||
================
|
||||
App Developement
|
||||
================
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 1
|
||||
|
||||
tutorial
|
||||
info
|
||||
classloader
|
||||
schema
|
||||
database
|
||||
static
|
||||
css
|
||||
javascript
|
||||
externalapi
|
||||
filesystem
|
||||
hooks
|
||||
data-migration
|
||||
@@ -13,7 +13,7 @@ Kanban Board = github issues + huboard
|
||||
We are using http://huboard.com to visualize ownCloud github issues as a `kanban
|
||||
board`_ (see: `core`_, `apps`_, `mirall`_):
|
||||
|
||||
.. figure:: ../images/kanbanexample.png
|
||||
.. figure:: ../../images/kanbanexample.png
|
||||
:scale: 70
|
||||
|
||||
As you may have noticed, the columns of the kanban board represent the
|
||||
|
||||
@@ -1,9 +1,19 @@
|
||||
.. _index:
|
||||
.. _appindex:
|
||||
|
||||
================
|
||||
App Developement
|
||||
================
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 1
|
||||
:hidden:
|
||||
|
||||
general/index
|
||||
intro/index
|
||||
app/index
|
||||
appframework/index
|
||||
classes/index
|
||||
|
||||
.. _Junior Jobs: http://owncloud.org/dev/junior-jobs/
|
||||
|
||||
|
||||
@@ -27,8 +37,8 @@ App Developement
|
||||
App Developement
|
||||
================
|
||||
|
||||
* :doc:`appintro/gettingstarted`
|
||||
* :doc:`appintro/createapp`
|
||||
* :doc:`intro/gettingstarted`
|
||||
* :doc:`intro/createapp`
|
||||
|
||||
Tutorial
|
||||
--------
|
||||
|
||||
17
developer_manual/commun/index.rst
Normal file
17
developer_manual/commun/index.rst
Normal file
@@ -0,0 +1,17 @@
|
||||
======================
|
||||
Help and Communication
|
||||
======================
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 1
|
||||
|
||||
* Ask a question on the `mailing list`_
|
||||
* Join the `IRC channel`_ **#owncloud-dev** on **irc.freenode.net**
|
||||
* `Contact`_ a maintainer of a certain app or division
|
||||
* Support users on the `mailing list`_ and on the `IRC channel`_
|
||||
|
||||
* Spread the word, tell your friends about it, write a blog post!
|
||||
|
||||
.. _mailing list: https://mail.kde.org/mailman/listinfo/owncloud
|
||||
.. _IRC channel: irc://#owncloud-dev@irc.freenode.net
|
||||
.. _Contact: http://owncloud.org/contact/
|
||||
@@ -12,10 +12,12 @@ ownCloud documentation contents
|
||||
.. toctree::
|
||||
:maxdepth: 3
|
||||
|
||||
general/index
|
||||
app/index
|
||||
core/index
|
||||
classes/index
|
||||
documentation/index
|
||||
testing/index
|
||||
translation/index
|
||||
commun/index
|
||||
|
||||
Indices and tables
|
||||
==================
|
||||
|
||||
@@ -1,11 +1,20 @@
|
||||
.. _coreindex:
|
||||
|
||||
=================
|
||||
Core Developement
|
||||
=================
|
||||
|
||||
.. toctree::
|
||||
:hidden:
|
||||
:maxdepth: 1
|
||||
|
||||
configfile
|
||||
translation
|
||||
theming
|
||||
unit-testing
|
||||
unit-testing
|
||||
|
||||
Core related docs
|
||||
|
||||
* :doc:`translation`
|
||||
* :doc:`unit-testing`
|
||||
* :doc:`theming`
|
||||
* :doc:`configfile`
|
||||
7
developer_manual/documentation/index.rst
Normal file
7
developer_manual/documentation/index.rst
Normal file
@@ -0,0 +1,7 @@
|
||||
=============
|
||||
Documentation
|
||||
=============
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 1
|
||||
|
||||
@@ -4,131 +4,31 @@
|
||||
Developer Documentation
|
||||
=======================
|
||||
|
||||
|
||||
How to Contribute
|
||||
=================
|
||||
If you want to contribute please read the `Contributor agreement FAQ`_
|
||||
|
||||
* Fix and triage bugs: `Report an issue on our bug tracker`_
|
||||
* `Translate <https://www.transifex.com/projects/p/owncloud/>`_ ownCloud to your language
|
||||
* Support users on the `mailing list`_ and on the `IRC channel`_
|
||||
* Take a job from our `Junior Jobs`_
|
||||
* Write and generate `documentation <https://github.com/owncloud/documentation>`_
|
||||
* Conduct `usability testing`_
|
||||
* Develop apps
|
||||
* Spread the word, tell your friends about it, write a blog post!
|
||||
|
||||
Getting Help
|
||||
============
|
||||
|
||||
* Ask a question on the `mailing list`_
|
||||
* Join the `IRC channel`_ #owncloud-dev on irc.freenode.net
|
||||
* `Contact`_ a maintainer of a certain app or division
|
||||
If you want to contribute please read the `Contributor agreement <http://owncloud.org/about/contributor-agreement/>`_
|
||||
|
||||
|
||||
General
|
||||
=======
|
||||
This chapter contains general guidelines and tutorials about
|
||||
+-------------------------+-------------------------+--------------------------+
|
||||
|:doc:`app/index` |:doc:`core/index` |:doc:`documentation/index`|
|
||||
| Develop apps for | Develop on the ownCloud | Create and enhance |
|
||||
| ownCloud and publish on | internals | documentation |
|
||||
| the `ownCloud appstore`_| | |
|
||||
+-------------------------+-------------------------+--------------------------+
|
||||
|`Usability Testing`_ |:doc:`testing/index` |`Bugtracker`_ |
|
||||
| Test the interface | Help to create unittests| Report, triage or fix |
|
||||
| for usability | acceptance tests and | bugs to improve quality |
|
||||
| | test experimental | |
|
||||
| | ownCloud versions | |
|
||||
+-------------------------+-------------------------+--------------------------+
|
||||
|:doc:`translation/index` |:doc:`commun/index` | |
|
||||
| Translate ownCloud into | Help on IRC, the | |
|
||||
| your language | mailinglist and forum | |
|
||||
+-------------------------+-------------------------+--------------------------+
|
||||
|
||||
* :doc:`general/security`
|
||||
* :doc:`general/codingguidelines`
|
||||
* :doc:`general/codereviews`
|
||||
* :doc:`general/debugging`
|
||||
* :doc:`general/kanban`
|
||||
* :doc:`general/angular` | `AngularJS Documentation <http://angularjs.org/>`_
|
||||
* :doc:`general/dependencyinjection` | `Pimple`_
|
||||
|
||||
App Developement
|
||||
================
|
||||
General instructions how to build your apps using the AppFramework app.
|
||||
|
||||
If the app is finished, it can be published in the `ownCloud app store <http://apps.owncloud.com/>`_
|
||||
|
||||
Tutorial
|
||||
--------
|
||||
|
||||
* :doc:`app/gettingstarted`
|
||||
|
||||
You can choose between the traditional and MVC style (App Framework) approach. In case of the App Framework, the App Framework app has to be installed and enabled.
|
||||
|
||||
* :doc:`app/apptutorial` | :doc:`app/appframeworktutorial`
|
||||
|
||||
Basics
|
||||
------
|
||||
* :doc:`app/settings`
|
||||
* :doc:`app/classloader`
|
||||
* :doc:`app/api` | :php:class:`OCA\\AppFramework\\Core\\API`
|
||||
|
||||
Routing
|
||||
-------
|
||||
Routing connects URLs with the controller methods.
|
||||
|
||||
* :doc:`app/routes`
|
||||
* :php:class:`OCA\\AppFramework\\App`
|
||||
|
||||
Controllers
|
||||
-----------
|
||||
Controllers run the database queries, pass variables to templates and return responses like JSON or templates.
|
||||
|
||||
* :doc:`app/controllers` | :php:class:`OCA\\AppFramework\\Controller\\Controller`
|
||||
|
||||
Database Access
|
||||
---------------
|
||||
Encapsulate SQL queries into objects to be able to change them easily.
|
||||
|
||||
* :doc:`app/database` | :php:class:`OCA\\AppFramework\\Db\\Mapper`
|
||||
|
||||
Templates
|
||||
---------
|
||||
Use templates for managing HTML code.
|
||||
|
||||
* :doc:`app/templates` | :php:class:`OC_Template`
|
||||
* :php:class:`OCA\\AppFramework\\Http\\TemplateResponse`
|
||||
|
||||
|
||||
|
||||
JavaScript & CSS
|
||||
----------------
|
||||
* :doc:`app/static`
|
||||
|
||||
Testing
|
||||
-------
|
||||
Automatically run unittests to prevent regressions.
|
||||
|
||||
* :doc:`app/unittesting`
|
||||
* :php:class:`OCA\\AppFramework\\Utility\\ControllerTestUtility`
|
||||
|
||||
Middleware
|
||||
----------
|
||||
Execute code before or after the controller like Security checks.
|
||||
|
||||
* :doc:`app/middleware` | :php:class:`OCA\\AppFramework\\Middleware\\Middleware`
|
||||
* :php:class:`OCA\\AppFramework\\Middleware\\Security\\SecurityMiddleware`
|
||||
* :php:class:`OCA\\AppFramework\\Middleware\\Twig\\TwigMiddleware`
|
||||
|
||||
ownCloud Interfaces
|
||||
-------------------
|
||||
ownCloud APIs that are ready to be built into the app
|
||||
|
||||
* :doc:`app/externalapi`
|
||||
* :doc:`app/filesystem`
|
||||
* :doc:`app/hooks`
|
||||
* :doc:`app/data-migration`
|
||||
|
||||
|
||||
Core Developement
|
||||
=================
|
||||
Core related docs
|
||||
|
||||
* :doc:`core/translation`
|
||||
* :doc:`core/unit-testing`
|
||||
* :doc:`core/theming`
|
||||
* :doc:`core/configfile`
|
||||
|
||||
API Documentation
|
||||
=================
|
||||
* :doc:`classes/appframework/index`
|
||||
* :doc:`classes/core/index`
|
||||
.. _Bugtracker: https://github.com/owncloud/core/issues
|
||||
.. _Usability Testing: http://jancborchardt.net/usability-in-free-software
|
||||
.. _ownCloud appstore: http://apps.owncloud.com/
|
||||
|
||||
Index and Tables
|
||||
================
|
||||
@@ -136,20 +36,3 @@ Index and Tables
|
||||
* :ref:`modindex`
|
||||
|
||||
|
||||
.. _Contributor agreement FAQ: http://owncloud.org/about/contributor-agreement/
|
||||
|
||||
.. _mailing list: https://mail.kde.org/mailman/listinfo/owncloud
|
||||
.. _IRC channel: irc://#owncloud-dev@irc.freenode.net
|
||||
.. _Contact: http://owncloud.org/contact/
|
||||
|
||||
.. _Report an issue on our bug tracker: https://github.com/owncloud/core/issues
|
||||
.. _Junior Jobs: http://owncloud.org/dev/junior-jobs/
|
||||
.. _usability testing: http://jancborchardt.net/usability-in-free-software
|
||||
|
||||
.. _git crash course: http://git-scm.com/course/svn.html
|
||||
|
||||
.. _Twig Templates: http://twig.sensiolabs.org/
|
||||
.. _Symfony Routing: http://symfony.com/doc/current/components/routing/introduction.html
|
||||
.. _Pimple: http://pimple.sensiolabs.org/
|
||||
.. _PHPUnit: http://www.phpunit.de/manual/current/en/
|
||||
|
||||
|
||||
7
developer_manual/testing/index.rst
Normal file
7
developer_manual/testing/index.rst
Normal file
@@ -0,0 +1,7 @@
|
||||
=======
|
||||
Testing
|
||||
=======
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 1
|
||||
|
||||
8
developer_manual/translation/index.rst
Normal file
8
developer_manual/translation/index.rst
Normal file
@@ -0,0 +1,8 @@
|
||||
===========
|
||||
Translation
|
||||
===========
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 1
|
||||
|
||||
* `Translate <https://www.transifex.com/projects/p/owncloud/>`_ ownCloud to your language
|
||||
Reference in New Issue
Block a user