khanh.pndc/nextcloud-docs
1
0
Fork 0
mirror of https://github.com/nextcloud/documentation.git synced 2026-01-04 02:36:49 +07:00
Code Issues Packages Projects Releases Wiki Activity

chore(developer): move ExApp intro and glossary to separate page

Browse Source 
Signed-off-by: Edward Ly <contact@edward.ly>
This commit is contained in:
Edward Ly
2024-10-23 10:56:17 -07:00
parent 2fad6d5c03
commit a682c73695
4 changed files with 36 additions and 33 deletions
Download Patch File Download Diff File Expand all files Collapse all files

35
developer_manual/exapp_development/Introduction.rst Normal file
View File

@@ -0,0 +1,35 @@
Introduction
============
**ExApps** (short for "External Apps") are Nextcloud apps that are developed in another programming language (outside of PHP) using the AppAPI OCS API.
AppAPI is a project introduced by Nextcloud to revolutionize the process of application development within the Nextcloud ecosystem.
Overview
--------
The main tasks of the AppAPI ecosystem are:
* Providing a reliable and fast method for authenticating applications
* Supporting various application deployment options
* Offering a clear and straightforward application administration interface
* Ensuring a reliable implementation of all the necessary missing APIs for applications
* Supplying clear, understandable documentation and support on how to implement libraries in other programming languages for writing next-gen applications for Nextcloud
If you have any questions or corrections regarding the documentation,
we would be glad to address them in discussions, incorporate corrections through pull requests,
and handle complex problems through issues.
Glossary
--------
AppAPI brings out the following terms frequently used in the code:
* ``ExApp`` (External App) - the app on another (from PHP) programming language, which uses AppAPI OCS API
* ``DaemonConfig`` - configuration of orchestration daemon (e.g. Docker) where ExApps are deployed
* ``DeployConfig`` - additional DaemonConfig options for orchestrator (e.g. network) and ExApps (nextcloud_url, host, etc.)
* ``ExAppConfig`` - similar to Nextcloud `app_config`, but for ExApps configuration
* ``ExAppPreferences`` - similar to Nextcloud `app_preferences`, user-specific settings for ExApps
* ``AppAPIAuth`` - AppAPI authentication
* ``ExAppScope`` - granted to ExApp scope group of access to API routes
* ``ExAppApiScope`` - pre-defined scope group of access to list of API routes
* ``FileActionsMenu`` - entry in files actions menu (context menu)

19
developer_manual/exapp_development/index.rst
View File

@@ -2,27 +2,10 @@
ExApp development
=================
**ExApps** (short for "External Apps") are Nextcloud apps that are developed in another programming language (outside of PHP) using the AppAPI OCS API.
AppAPI is a project introduced by Nextcloud to revolutionize the process of application development within the Nextcloud ecosystem.
Overview
--------
The main tasks of the AppAPI ecosystem are:
* Providing a reliable and fast method for authenticating applications
* Supporting various application deployment options
* Offering a clear and straightforward application administration interface
* Ensuring a reliable implementation of all the necessary missing APIs for applications
* Supplying clear, understandable documentation and support on how to implement libraries in other programming languages for writing next-gen applications for Nextcloud
If you have any questions or corrections regarding the documentation,
we would be glad to address them in discussions, incorporate corrections through pull requests,
and handle complex problems through issues.
.. toctree::
:maxdepth: 2
Introduction
DevSetup
tech_details/index.rst
notes_for_developers/index.rst

14
developer_manual/exapp_development/tech_details/Glossary.rst
View File

@@ -1,14 +0,0 @@
Glossary
========
AppAPI brings out the following terms frequently used in the code:
* ``ExApp`` (External App) - the app on another (from PHP) programming language, which uses AppAPI OCS API
* ``DaemonConfig`` - configuration of orchestration daemon (e.g. Docker) where ExApps are deployed
* ``DeployConfig`` - additional DaemonConfig options for orchestrator (e.g. network) and ExApps (nextcloud_url, host, etc.)
* ``ExAppConfig`` - similar to Nextcloud `app_config`, but for ExApps configuration
* ``ExAppPreferences`` - similar to Nextcloud `app_preferences`, user-specific settings for ExApps
* ``AppAPIAuth`` - AppAPI authentication
* ``ExAppScope`` - granted to ExApp scope group of access to API routes
* ``ExAppApiScope`` - pre-defined scope group of access to list of API routes
* ``FileActionsMenu`` - entry in files actions menu (context menu)

1
developer_manual/exapp_development/tech_details/index.rst
View File

@@ -4,7 +4,6 @@ Technical details
.. toctree::
:maxdepth: 2
Glossary
InstallationFlow
ApiScopes
Deployment