diff --git a/source/development/index.rst b/source/development/index.rst deleted file mode 100644 index e1e5277c14a670c45f23b5cab08662d02cac2360..0000000000000000000000000000000000000000 --- a/source/development/index.rst +++ /dev/null @@ -1,9 +0,0 @@ -Development Worflows -==================== - -We follow a specific workflow to label our tickets during their life cycle - -.. toctree:: - :maxdepth: 2 - - workflow-tickets.rst diff --git a/source/development/workflow-tickets.rst b/source/development/workflow-tickets.rst deleted file mode 100644 index 0c5f874a7b5da2bbf576d0eb726e822825d8df6c..0000000000000000000000000000000000000000 --- a/source/development/workflow-tickets.rst +++ /dev/null @@ -1,103 +0,0 @@ -New ticket opened -================= - -First the label of the dolibarr project should be added to it. -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -The dolibarr label are made like this : **PJYYYY**-project number - -We have some basic project number that should always be used by default if there is no customer project. - -- FusionDirectory / Automated Testing / FusionDirectory demo : - **PJ1802-0188** - -- Argonaut : **PJ1802-0190** - -- Packaging Debian / Redhat / Centos / Ubuntu : **PJ1802-0189** - -- Gitlab-ci changes : **PJ1802-0188** - -- User-manual : **PJ2003-0342** - -- Dev Manual : **PJ2003-0343** - -.. warning:: - - if the label doesnt exist it need to be created at the group level - for exemple : `Group Label`_ - -Second the component where the bug/enhancement is to be made should be specified -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -- Example : fusiondirectory-core or plugin-xxx - -.. warning:: - - It could be several component - -Third if this is a customer under contract the level of support should be added also -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -- Example : basic, intermediate, expert, premium - -Ticket as been treated -====================== - -you need to input you time into the ticket with **/spend** with a choice of xxmin, xxhours, xxdays - -.. warning:: - - Very important as it allow to caculate the time spend on this feature or fix - -if some code has been commited and need to be tested -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -- The **to be tested** label should be added - -if some more info is needed to act on the report -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -- The **need info** label should be added, don’t hesitate to ping the - user reporting the bug with **@(useranme)** to ask him to check it out - -If the change need to be merged in a fixed version -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -- The **fixes** label is added, when the cherry-pick as been merged we - remove the **fixes** and add the **fixes-merged** label - -if the change need a change in packaging -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -- The **packaging** label is added and a corresponding ticket is open - in the corresponding distribution projects - - - `Debian Packaging`_ - - `Centos Packaging`_ - - `Ubuntu Packaging`_ - - -- The packaging ticket are linked back with the code fix ticket - -Ticket need to be closed -======================== - -- Remove the **to be tested** label, and add one of the changelog label - to specify what has been done. - - - Added - - Changed - - Deprecated - - Fixed - - Removed - - Security - -Those label are used to generate a changelog when we release a new -version of the software, and also used when we want to search in which -version something has been changed and what the type of change it was - - -.. _Debian Packaging : https://gitlab.fusiondirectory.org/debian -.. _Centos Packaging : https://gitlab.fusiondirectory.org/centos -.. _Ubuntu Packaging : https://gitlab.fusiondirectory.org/ubuntu -.. _Group Label : https://gitlab.fusiondirectory.org/groups/fusiondirectory/-/labels diff --git a/source/fusiondirectory/libraries/cli.rst b/source/fusiondirectory-integrator/cli.rst similarity index 100% rename from source/fusiondirectory/libraries/cli.rst rename to source/fusiondirectory-integrator/cli.rst diff --git a/source/fusiondirectory-integrator/index.rst b/source/fusiondirectory-integrator/index.rst new file mode 100644 index 0000000000000000000000000000000000000000..e9aa6fd49a9f951e50f80a9ce05d0f48ac0736ae --- /dev/null +++ b/source/fusiondirectory-integrator/index.rst @@ -0,0 +1,9 @@ +FusionDirectory Integrator +========================== + +.. toctree:: + :maxdepth: 2 + + ldap + cli + diff --git a/source/fusiondirectory/libraries/ldap.rst b/source/fusiondirectory-integrator/ldap.rst similarity index 100% rename from source/fusiondirectory/libraries/ldap.rst rename to source/fusiondirectory-integrator/ldap.rst diff --git a/source/marketplace/index.rst b/source/fusiondirectory-marketplace/index.rst similarity index 92% rename from source/marketplace/index.rst rename to source/fusiondirectory-marketplace/index.rst index 231c95943194f4fabff1ce4f32753d86a35f1699..63dc74aa966c22bede6cb262e6a2300389396a58 100644 --- a/source/marketplace/index.rst +++ b/source/fusiondirectory-marketplace/index.rst @@ -1,4 +1,4 @@ -FusionDirectory marketplace +FusionDirectory Marketplace =========================== The FusionDirectory marketplace is the best way to find new plugins for FusionDirectory. diff --git a/source/marketplace/yaml/index.rst b/source/fusiondirectory-marketplace/yaml/index.rst similarity index 100% rename from source/marketplace/yaml/index.rst rename to source/fusiondirectory-marketplace/yaml/index.rst diff --git a/source/marketplace/yaml/tags.rst b/source/fusiondirectory-marketplace/yaml/tags.rst similarity index 100% rename from source/marketplace/yaml/tags.rst rename to source/fusiondirectory-marketplace/yaml/tags.rst diff --git a/source/marketplace/yaml/yaml.rst b/source/fusiondirectory-marketplace/yaml/yaml.rst similarity index 100% rename from source/marketplace/yaml/yaml.rst rename to source/fusiondirectory-marketplace/yaml/yaml.rst diff --git a/source/fusiondirectory-orchestrator/index.rst b/source/fusiondirectory-orchestrator/index.rst new file mode 100644 index 0000000000000000000000000000000000000000..4596c59432ed7ae9279fc8b315555601b6a6761c --- /dev/null +++ b/source/fusiondirectory-orchestrator/index.rst @@ -0,0 +1,8 @@ +FusionDirectory Orchestrator +============================ + +.. toctree:: + :maxdepth: 2 + + whatis/orchestrator.rst + requirements/mandatory.rst diff --git a/source/fusiondirectory-orchestrator/requirements/mandatory.rst b/source/fusiondirectory-orchestrator/requirements/mandatory.rst new file mode 100644 index 0000000000000000000000000000000000000000..9e31e6a063223e1db9ee00a92e2eb0542f000398 --- /dev/null +++ b/source/fusiondirectory-orchestrator/requirements/mandatory.rst @@ -0,0 +1,48 @@ +Mandatory Components +==================== + +FusionDirectory Orchestrator is a Web application that will need: + +* A webserver; +* PHP; +* An ldap server; +* Fusion Directory 1.5 with configured tasks. + +Web server +---------- + +FusionDirectory Orchestrator requires the following web server that supports PHP and URL Rewriting: + +* `Apache 2 (or more recent) <http://httpd.apache.org>`_; +* `Nginx <http://nginx.org/>`_; + +PHP +--- + +FusionDirectory Orchestrator 1.1 works with `PHP <https://www.php.net>`_ 7.4 and PHP 8.0. + +Mandatory extensions +^^^^^^^^^^^^^^^^^^^^ + +Following PHP extensions are required for the app to work properly: + +* ``curl``: to communicate with different types of servers and protocols +* ``filter``: to filters a variable with a specified filter; +* ``json``: to get support for JSON data format; +* ``mbstring``: to manage multi bytes characters; +* ``ldap``: to connect and query the ldap server; +* ``openssl``: secured communications and generation of secure tokens; +* ``session``: to get user sessions support; +* ``simplexml``; +* ``xml``. + +LDAP server +----------- + +FusionDirectory Orchestrator will use the LDAP server managed by your FusionDirectory. + +Servers know to work are : + +* `OpenLDAP`_ + +.. _OpenLDAP : https://www.openldap.org/ diff --git a/source/fusiondirectory-orchestrator/whatis/orchestrator.rst b/source/fusiondirectory-orchestrator/whatis/orchestrator.rst new file mode 100644 index 0000000000000000000000000000000000000000..8e67dfa287144a90169f39f9fee9f55f59edfaf5 --- /dev/null +++ b/source/fusiondirectory-orchestrator/whatis/orchestrator.rst @@ -0,0 +1,65 @@ +What is FusionDirectory Orchestrator ? +====================================== + +FusionDirectory Orchestrator is a RESTful web service using JWT authentication, designed to manage and execute tasks efficiently. + +It supports multiple endpoints with plugin integration for custom processing or specialized tasks. + +Tasks are defined within FusionDirectory, with a client available to query endpoints and manage workflows. + +Common tasks include account lifecycle, notifications, reminders, mail automation, audit log management, and more. + +Features +^^^^^^^^ + +- Tasks management. +- Tasks execution. +- Workflow management. +- JWT Authentication methods + + +Tasks management +^^^^^^^^^^^^^^^^ + +FusionDirectory Orchestrator REST API provides seamless management and retrieval of tasks created within FusionDirectory. +It offers a clear and concise view of the status of each task, including subtasks, allowing for detailed tracking and reporting. + +With its extensible design, the Orchestrator supports specialized tasks such as mail automation, notifications, reminders, +account lifecycle management, and audit log processing, enabling tailored workflows to meet diverse needs + +Tasks Execution +^^^^^^^^^^^^^^^^ + +One of the core functionalities of the **FusionDirectory Orchestrator** is the execution and processing of various tasks as defined within FusionDirectory. + +- **Mail Tasks**: + When triggered, tasks of type "Mail" will automatically send the relevant emails if the scheduled conditions are met, ensuring timely communication. + +- **Life Cycle Tasks**: + These tasks are responsible for updating specialized attributes, such as *supann* attributes, in accordance with defined lifecycle processes. + +- **Notification Tasks**: + When attributes are modified, "Notification" tasks will send automated email alerts to keep users informed of changes. + +- **Reminder Tasks**: + These tasks send reminders to users, potentially including links to extend or prolong their account, ensuring critical actions are not missed. + +- **Audit Tasks**: + Tasks of this type allow for the management of audit logs, including the deletion of logs based on configurable retention policies, ensuring compliance and data management. + +The **Orchestrator client** provides a user-friendly interface to activate and manage these tasks, allowing for seamless workflow execution and efficient task orchestration across the system. + +JWT Authentication +^^^^^^^^^^^^^^^^^^^ + +To strengthen our authentication mechanism, we have adopted the **JWT (JSON Web Token)** methodology. + +After a successful username/password authentication, the user receives two tokens: + +- **Access Token**: + This token is used to authorize and perform operations on FusionDirectory Orchestrator endpoints. + +- **Refresh Token**: + This token is used to obtain a new access token when the current one expires, ensuring seamless and secure access without requiring repeated login attempts. + +This approach enhances security while simplifying the authentication process, enabling efficient and secure communication with the Orchestrator API. \ No newline at end of file diff --git a/source/fusiondirectory-webservice/index.rst b/source/fusiondirectory-webservice/index.rst new file mode 100644 index 0000000000000000000000000000000000000000..8198db8ac3647f17c597b80caf460e582436a18f --- /dev/null +++ b/source/fusiondirectory-webservice/index.rst @@ -0,0 +1,8 @@ +FusionDirectory REST Webservice +=============================== + +.. toctree:: + :maxdepth: 2 + + webservice.rst + diff --git a/source/fusiondirectory/api/webservice.rst b/source/fusiondirectory-webservice/webservice.rst similarity index 97% rename from source/fusiondirectory/api/webservice.rst rename to source/fusiondirectory-webservice/webservice.rst index 788a68a919392bd0b6648cd945540309b33ac50d..edf79fe8e05e24cf044c4cb00d4c6725e8625b7c 100644 --- a/source/fusiondirectory/api/webservice.rst +++ b/source/fusiondirectory-webservice/webservice.rst @@ -1,7 +1,7 @@ Fusiondirectory WebService ========================== -FusionDirectory WebService plugin exposes a REST webservice that you can use if you want to access LDAP content through FusionDirectory system. +FusionDirectory WebService plugin exposes a REST webservice that you can use if you want to access LDAP content through FusionDirectory. This way, you ensure that your ldap objects are kept consistent, your are able to use the system templates and have restrictions applied by acls. On top of that you have a nicer API than the low-level LDAP one. diff --git a/source/fusiondirectory/api/api.rst b/source/fusiondirectory/development/api/api.rst similarity index 100% rename from source/fusiondirectory/api/api.rst rename to source/fusiondirectory/development/api/api.rst diff --git a/source/fusiondirectory/api/index.rst b/source/fusiondirectory/development/api/index.rst similarity index 82% rename from source/fusiondirectory/api/index.rst rename to source/fusiondirectory/development/api/index.rst index e1340bd1fbe1e9ad2f7111d703314239e1c43632..01363168c8090231558cb4224f714a30db41bc31 100644 --- a/source/fusiondirectory/api/index.rst +++ b/source/fusiondirectory/development/api/index.rst @@ -7,5 +7,4 @@ FusionDirectory :maxdepth: 2 api - webservice diff --git a/source/fusiondirectory/coding/codingstandards.rst b/source/fusiondirectory/development/codingstyle/codingstandards.rst similarity index 100% rename from source/fusiondirectory/coding/codingstandards.rst rename to source/fusiondirectory/development/codingstyle/codingstandards.rst diff --git a/source/fusiondirectory/coding/copyright.rst b/source/fusiondirectory/development/codingstyle/copyright.rst similarity index 100% rename from source/fusiondirectory/coding/copyright.rst rename to source/fusiondirectory/development/codingstyle/copyright.rst diff --git a/source/fusiondirectory/coding/index.rst b/source/fusiondirectory/development/codingstyle/index.rst similarity index 100% rename from source/fusiondirectory/coding/index.rst rename to source/fusiondirectory/development/codingstyle/index.rst diff --git a/source/fusiondirectory/coding/sourcecode.rst b/source/fusiondirectory/development/codingstyle/sourcecode.rst similarity index 100% rename from source/fusiondirectory/coding/sourcecode.rst rename to source/fusiondirectory/development/codingstyle/sourcecode.rst diff --git a/source/fusiondirectory/contribute/guidelines.rst b/source/fusiondirectory/development/contribute/guidelines.rst similarity index 100% rename from source/fusiondirectory/contribute/guidelines.rst rename to source/fusiondirectory/development/contribute/guidelines.rst diff --git a/source/fusiondirectory/development/index.rst b/source/fusiondirectory/development/index.rst new file mode 100644 index 0000000000000000000000000000000000000000..9f76840c5e27ee729493dae639cf9298daddcefa --- /dev/null +++ b/source/fusiondirectory/development/index.rst @@ -0,0 +1,11 @@ +Development +=========== + +.. toctree:: + :maxdepth: 2 + + + contribute/guidelines.rst + codingstyle/index.rst + writeplugin/index.rst + api/index.rst diff --git a/source/fusiondirectory/pluginsystem/attributes.rst b/source/fusiondirectory/development/writeplugin/attributes.rst similarity index 100% rename from source/fusiondirectory/pluginsystem/attributes.rst rename to source/fusiondirectory/development/writeplugin/attributes.rst diff --git a/source/fusiondirectory/pluginsystem/configbackend.rst b/source/fusiondirectory/development/writeplugin/configbackend.rst similarity index 100% rename from source/fusiondirectory/pluginsystem/configbackend.rst rename to source/fusiondirectory/development/writeplugin/configbackend.rst diff --git a/source/fusiondirectory/pluginsystem/folders.rst b/source/fusiondirectory/development/writeplugin/folders.rst similarity index 100% rename from source/fusiondirectory/pluginsystem/folders.rst rename to source/fusiondirectory/development/writeplugin/folders.rst diff --git a/source/fusiondirectory/pluginsystem/further.rst b/source/fusiondirectory/development/writeplugin/further.rst similarity index 100% rename from source/fusiondirectory/pluginsystem/further.rst rename to source/fusiondirectory/development/writeplugin/further.rst diff --git a/source/fusiondirectory/pluginsystem/index.rst b/source/fusiondirectory/development/writeplugin/index.rst similarity index 100% rename from source/fusiondirectory/pluginsystem/index.rst rename to source/fusiondirectory/development/writeplugin/index.rst diff --git a/source/fusiondirectory/pluginsystem/menusections.rst b/source/fusiondirectory/development/writeplugin/menusections.rst similarity index 100% rename from source/fusiondirectory/pluginsystem/menusections.rst rename to source/fusiondirectory/development/writeplugin/menusections.rst diff --git a/source/fusiondirectory/pluginsystem/plinfo.rst b/source/fusiondirectory/development/writeplugin/plinfo.rst similarity index 100% rename from source/fusiondirectory/pluginsystem/plinfo.rst rename to source/fusiondirectory/development/writeplugin/plinfo.rst diff --git a/source/fusiondirectory/pluginsystem/start.rst b/source/fusiondirectory/development/writeplugin/start.rst similarity index 100% rename from source/fusiondirectory/pluginsystem/start.rst rename to source/fusiondirectory/development/writeplugin/start.rst diff --git a/source/fusiondirectory/index.rst b/source/fusiondirectory/index.rst index 550377b5c10e1c1f04748671faa8990725e592da..0efdce60492ffdcf80c6624a8482be5894b88578 100644 --- a/source/fusiondirectory/index.rst +++ b/source/fusiondirectory/index.rst @@ -12,16 +12,7 @@ Contents: :maxdepth: 2 whatis/fusiondirectory.rst - prerequisite/prerequisite.rst - distribution/certified-distribution.rst - contribute/guidelines.rst - coding/index - pluginsystem/index - api/index - schemas/index - themes/index - translate/translation.rst - release/index - license/license.rst - libraries/index - + requirements/index.rst + development/index.rst + interface/index.rst + translation/translation.rst diff --git a/source/fusiondirectory/themes/index.rst b/source/fusiondirectory/interface/index.rst similarity index 100% rename from source/fusiondirectory/themes/index.rst rename to source/fusiondirectory/interface/index.rst diff --git a/source/fusiondirectory/themes/themes.rst b/source/fusiondirectory/interface/themes.rst similarity index 100% rename from source/fusiondirectory/themes/themes.rst rename to source/fusiondirectory/interface/themes.rst diff --git a/source/fusiondirectory/libraries/index.rst b/source/fusiondirectory/libraries/index.rst deleted file mode 100644 index e82e809eb76dc0f539dbd59c0f5d758233a25dc1..0000000000000000000000000000000000000000 --- a/source/fusiondirectory/libraries/index.rst +++ /dev/null @@ -1,11 +0,0 @@ -Libraries -========= - -Contents: - -.. toctree:: - :maxdepth: 2 - - ldap - cli - diff --git a/source/fusiondirectory/distribution/certified-distribution.rst b/source/fusiondirectory/requirements/certified-distributions.rst similarity index 84% rename from source/fusiondirectory/distribution/certified-distribution.rst rename to source/fusiondirectory/requirements/certified-distributions.rst index 3a34ebde1e16a6aa7e851b1e076e5d10968a3ea6..fd26964a1706c63d8c4cb86e091b367122aee1ce 100644 --- a/source/fusiondirectory/distribution/certified-distribution.rst +++ b/source/fusiondirectory/requirements/certified-distributions.rst @@ -4,10 +4,10 @@ Certified distributions We certify FusionDirectory with all the most common distributions, here is a table which summarizes the level of support by distribution and version. - * Fusiondirectory 1.4 need = PHP 7.4 + * Fusiondirectory 1.5 need = PHP 7.4 ================= ======================== -DISTRIBUTION FusionDirectory 1.4 +DISTRIBUTION FusionDirectory 1.5 ================= ======================== Debian Buster supported Debian Bullseyes supported @@ -16,6 +16,6 @@ Ubuntu 16.04 LTS not supported Ubuntu 18.04 LTS not supported Ubuntu 20.04 LTS supported ----------------- ------------------------ -Centos 7 supported +Centos 7 not supported Centos 8 not supported ================= ======================== diff --git a/source/fusiondirectory/requirements/index.rst b/source/fusiondirectory/requirements/index.rst new file mode 100644 index 0000000000000000000000000000000000000000..447d605d14d3defb542d4ff0da1c341bf5ad13d1 --- /dev/null +++ b/source/fusiondirectory/requirements/index.rst @@ -0,0 +1,8 @@ +Requirements +============ + +.. toctree:: + :maxdepth: 2 + + mandatory.rst + certified-distributions.rst diff --git a/source/fusiondirectory/prerequisite/prerequisite.rst b/source/fusiondirectory/requirements/mandatory.rst similarity index 89% rename from source/fusiondirectory/prerequisite/prerequisite.rst rename to source/fusiondirectory/requirements/mandatory.rst index b0977b0f0f7871fc7a7bc44881a7661eed875d7d..88e7773eaca41b33e1b4a7beb664777a75f68c7f 100644 --- a/source/fusiondirectory/prerequisite/prerequisite.rst +++ b/source/fusiondirectory/requirements/mandatory.rst @@ -1,11 +1,5 @@ -Prerequisites -============= - -FusionDirectory is a Web application that will need: - -* a webserver; -* PHP; -* an ldap server; +Mandatory Components +==================== Web server ---------- @@ -14,7 +8,6 @@ FusionDirectory requires a web server that supports PHP, like: * `Apache 2 (or more recent) <http://httpd.apache.org>`_; * `Nginx <http://nginx.org/>`_; -* `Microsoft IIS <https://www.iis.net>`_. PHP --- @@ -78,7 +71,5 @@ For FusionDirectory to work you need an ldap server. Servers know to work are : * `OpenLDAP`_ -* `389DS`_ .. _OpenLDAP : https://www.openldap.org/ -.. _389DS : https://directory.fedoraproject.org/ diff --git a/source/fusiondirectory/translate/translation.rst b/source/fusiondirectory/translation/translation.rst similarity index 100% rename from source/fusiondirectory/translate/translation.rst rename to source/fusiondirectory/translation/translation.rst diff --git a/source/index.rst b/source/index.rst index 66609f0b4bbb967d51a76a87af5b3568278eb701..bd744aaf3dfbedfef749b432b778ed912c922c00 100644 --- a/source/index.rst +++ b/source/index.rst @@ -17,10 +17,13 @@ Contents: :maxdepth: 2 fusiondirectory/index.rst - development/index.rst - marketplace/index.rst - releasing/index.rst - new-version/index.rst + fusiondirectory-integrator/index.rst + fusiondirectory-orchestrator/index.rst + fusiondirectory-webservice/index.rst + fusiondirectory-marketplace/index.rst + ldap/index.rst + release/index.rst + license/license.rst support/index.rst security/index.rst contact/contact.rst diff --git a/source/fusiondirectory/schemas/iana.rst b/source/ldap/iana.rst similarity index 100% rename from source/fusiondirectory/schemas/iana.rst rename to source/ldap/iana.rst diff --git a/source/fusiondirectory/schemas/index.rst b/source/ldap/index.rst similarity index 100% rename from source/fusiondirectory/schemas/index.rst rename to source/ldap/index.rst diff --git a/source/fusiondirectory/schemas/namerules.rst b/source/ldap/namerules.rst similarity index 100% rename from source/fusiondirectory/schemas/namerules.rst rename to source/ldap/namerules.rst diff --git a/source/fusiondirectory/schemas/numberrules.rst b/source/ldap/numberrules.rst similarity index 100% rename from source/fusiondirectory/schemas/numberrules.rst rename to source/ldap/numberrules.rst diff --git a/source/fusiondirectory/schemas/schemaname.rst b/source/ldap/schemaname.rst similarity index 100% rename from source/fusiondirectory/schemas/schemaname.rst rename to source/ldap/schemaname.rst diff --git a/source/fusiondirectory/schemas/schemaweb.rst b/source/ldap/schemaweb.rst similarity index 100% rename from source/fusiondirectory/schemas/schemaweb.rst rename to source/ldap/schemaweb.rst diff --git a/source/fusiondirectory/license/license.rst b/source/license/license.rst similarity index 100% rename from source/fusiondirectory/license/license.rst rename to source/license/license.rst diff --git a/source/new-version/index.rst b/source/new-version/index.rst deleted file mode 100644 index 34b618152e3ec6504134e1289ff7088ee30ba551..0000000000000000000000000000000000000000 --- a/source/new-version/index.rst +++ /dev/null @@ -1,12 +0,0 @@ -creating a new version our softwares -==================================== - -How to create a new version of our various softwares - -.. toctree:: - :maxdepth: 2 - - new-fusiondirectory.rst - new-fusiondirectory-integrator.rst - new-fusiondirectory-orchestrator.rst - new-fusiondirectory-tools.rst diff --git a/source/new-version/new-fusiondirectory-integrator.rst b/source/new-version/new-fusiondirectory-integrator.rst deleted file mode 100644 index 14a2d9c729e8f215f341e451a8d7041d97125aa7..0000000000000000000000000000000000000000 --- a/source/new-version/new-fusiondirectory-integrator.rst +++ /dev/null @@ -1,16 +0,0 @@ -Creating a new version of FusionDirectory Integrator -==================================================== - -- Create the new milestone -- Create the new branchs from master - -Create the new milestone -^^^^^^^^^^^^^^^^^^^^^^^^ - -- got to FusionDirectory `milestones`_ and create the new milestone, version is the version number - - - FusionDirectory Integrator version - - Start date, date of the milestone creation - - Stop date is start date + 6 month - -.. _milestones : https://gitlab.fusiondirectory.org/groups/fusiondirectory/-/milestones diff --git a/source/new-version/new-fusiondirectory-orchestrator.rst b/source/new-version/new-fusiondirectory-orchestrator.rst deleted file mode 100644 index 57ab49f2155686b5910e57d10ba50f6b6e0cf4f8..0000000000000000000000000000000000000000 --- a/source/new-version/new-fusiondirectory-orchestrator.rst +++ /dev/null @@ -1,16 +0,0 @@ -Creating a new version of FusionDirectory Orchestrator -====================================================== - -- Create the new milestone -- Create the new branchs from master - -Create the new milestone -^^^^^^^^^^^^^^^^^^^^^^^^ - -- got to FusionDirectory `milestones`_ and create the new milestone, version is the version number - - - FusionDirectory Orchestrator version - - Start date, date of the milestone creation - - Stop date is start date + 6 month - -.. _milestones : https://gitlab.fusiondirectory.org/groups/fusiondirectory/-/milestones diff --git a/source/new-version/new-fusiondirectory-tools.rst b/source/new-version/new-fusiondirectory-tools.rst deleted file mode 100644 index cf5cb107ec0076dd2ea32d934e657c1868a6d926..0000000000000000000000000000000000000000 --- a/source/new-version/new-fusiondirectory-tools.rst +++ /dev/null @@ -1,16 +0,0 @@ -Creating a new version of FusionDirectory Tools -=============================================== - -- Create the new milestone -- Create the new branchs from master - -Create the new milestone -^^^^^^^^^^^^^^^^^^^^^^^^ - -- got to FusionDirectory `milestones`_ and create the new milestone, version is the version number - - - FusionDirectory Orchestrator version - - Start date, date of the milestone creation - - Stop date is start date + 6 month - -.. _milestones : https://gitlab.fusiondirectory.org/groups/fusiondirectory/-/milestones diff --git a/source/new-version/new-fusiondirectory.rst b/source/new-version/new-fusiondirectory.rst deleted file mode 100644 index 0dae1e8b9a924f5143731ce304c94dd4d81ade4d..0000000000000000000000000000000000000000 --- a/source/new-version/new-fusiondirectory.rst +++ /dev/null @@ -1,15 +0,0 @@ -Creating a new version of FusionDirectory -========================================= - -- Create the new milestone - -Create the new milestone -^^^^^^^^^^^^^^^^^^^^^^^^ - -- got to FusionDirectory `milestones`_ and create the new milestone, version is the version number - - - FusionDirectory version - - Start date, date of the milestone creation - - Stop date is start date + 6 month - -.. _milestones : https://gitlab.fusiondirectory.org/groups/fusiondirectory/-/milestones diff --git a/source/fusiondirectory/release/esr.rst b/source/release/esr.rst similarity index 100% rename from source/fusiondirectory/release/esr.rst rename to source/release/esr.rst diff --git a/source/fusiondirectory/release/index.rst b/source/release/index.rst similarity index 100% rename from source/fusiondirectory/release/index.rst rename to source/release/index.rst diff --git a/source/fusiondirectory/release/releasepolicy.rst b/source/release/releasepolicy.rst similarity index 100% rename from source/fusiondirectory/release/releasepolicy.rst rename to source/release/releasepolicy.rst diff --git a/source/releasing/fusiondirectory-integrator.rst b/source/releasing/fusiondirectory-integrator.rst deleted file mode 100644 index 3d94449677274f5373fd82db124cede6fec9f2ef..0000000000000000000000000000000000000000 --- a/source/releasing/fusiondirectory-integrator.rst +++ /dev/null @@ -1,83 +0,0 @@ -How to release a FusionDirectory Integrator Version -=================================================== - -- Update the AUTHORS.md file -- Updates the Changelog.md file -- Write the upgrade documentation -- Update the UPGRADE.md -- Merge the branch into master - -All those operations have to be made onto a branch each one -of them inside a ticket with the label ~release and with a **MR** - -Update the AUTHORS file -^^^^^^^^^^^^^^^^^^^^^^^ - -Add the authors of all the patchs we received to the AUTHORS file - -:: - - * Markus Amersdorfer <der.plusch@subnet.at> - Wiki setup, Testing, hints, proposals - -Updates the Changelog.md -^^^^^^^^^^^^^^^^^^^^^^^^ - -To update the Changelog.md you must first run the following command, at the end you have to put the milestone you want a changelog for - -.. code:: shell - - gitlab_changelog.py --config-file ~/.python-gitlab.cfg --gitlab fd --project "fusiondirectory/fusiondirectory-integrator" "FusionDirectory Integrator 1.1" - -Update the user documentation -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -open an issue ins the `user manual issues`_ to update the release notes for -the supported version, label this issue ~release and with the correct -milestone - -The content should got into **source/fusiondirectory-integrator/supported** - -the file should be named like in this example current version to new version - -1.0-to-1.1.rst - -Update the UPGRADE documentation -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -Update UPGRADE.md with a new section for the new version corresponding -to what you have put into `user manual supported`_ after updating the documentation -for the release - -you can run for example - -.. code:: shell - - pandoc --from rst --to markdown -o 1.0-to-1.1.md 1.0-to-1.1.rst - -directly in the user-manual source to generate the content to copy/paste at the end of UPGRADE.MD - -Merge the branch into master -^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -Only a gitlab master account user can do the merge on the master branch - -Tag the release -^^^^^^^^^^^^^^^ - -After merging the release we need to tag the release. go to `FusionDirectory Integrator tags`_ - -- Paste the Changelog.md corresponding to the release we just made - -Run the ci for the fusiondirectory-integrator website -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -Once the tags for a release are created the CI of fusiondirectory-integrator needs to run -to update the fusiondirectory integrator website. - -The CI is at `FusionDirectory Integrator API`_ - -.. _user manual issues: https://gitlab.fusiondirectory.org/fusiondirectory/user-manual/-/issues -.. _user manual supported : https://fusiondirectory-user-manual.readthedocs.io/en/latest/fusiondirectory-integrator/update/supported/index.html -.. _FusionDirectory Integrator tags : https://gitlab.fusiondirectory.org/fusiondirectory/fusiondirectory-integrator/-/tags -.. _Fusiondirectory Integrator API : https://gitlab.fusiondirectory.org/applications/fusiondirectory-integrator/-/pipelines diff --git a/source/releasing/fusiondirectory-orchestrator.rst b/source/releasing/fusiondirectory-orchestrator.rst deleted file mode 100644 index 556390939737d81907925f71d65621c167c2bdfa..0000000000000000000000000000000000000000 --- a/source/releasing/fusiondirectory-orchestrator.rst +++ /dev/null @@ -1,83 +0,0 @@ -How to release a FusionDirectory Orchestrator Version -===================================================== - -- Update the AUTHORS.md file -- Updates the Changelog.md -- Write the upgrade documentation -- Update the UPGRADE.md -- Merge the branch into master - -All those operations have to be made onto a branch each one -of them inside a ticket with the label ~release and with a **MR** - -Update the AUTHORS file -^^^^^^^^^^^^^^^^^^^^^^^ - -Add the authors of all the patchs we received to the AUTHORS file - -:: - - * Markus Amersdorfer <der.plusch@subnet.at> - Wiki setup, Testing, hints, proposals - -Updates the Changelog.md -^^^^^^^^^^^^^^^^^^^^^^^^ - -To update the Changelog.md you must first run the following command, at the end you have to put the milestone you want a changelog for - -.. code:: shell - - gitlab_changelog.py --config-file ~/.python-gitlab.cfg --gitlab fd --project "fusiondirectory/fusiondirectory-orchestrator "FusionDirectory Orchestrator 1.1" - -Update the user documentation -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -open an issue ins the `user manual issues`_ to update the release notes for -the supported version, label this issue ~release and with the correct -milestone - -The content should got into **source/fusiondirectory-orchestrator/update/supported** - -the file should be named like in this example current version to new version - -1.0-to-1.1.rst - -Update the UPGRADE documentation -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -Update UPGRADE.md with a new section for the new version corresponding -to what you have put into `user manual supported`_ after updating the documentation -for the release - -you can run for example - -.. code:: shell - - pandoc --from rst --to markdown -o 1.0-to-1.1.md 1.0-to-1.1.rst - -directly in the user-manual source to generate the content to copy/paste at the end of UPGRADE.MD - -Merge the branch into master -^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -Only a gitlab master account user can do the merge on the master branch - -Tag the release -^^^^^^^^^^^^^^^ - -After merging the release we need to tag the release. go to `FusionDirectory Orchestrator tags`_ - -- Paste the Changelog.md corresponding to the release we just made - -Run the ci for the FusionDirectory Orchestrator website -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -Once the tag for a release are created the CI of FusionDirectory Orchestrator project needs to run -to update the FusionDirectory Orchestrator API website - -The CI is at `FusionDirectory Orchestrator API`_ - -.. _user manual issues: https://gitlab.fusiondirectory.org/fusiondirectory/user-manual/-/issues -.. _user manual supported : https://fusiondirectory-user-manual.readthedocs.io/en/latest/fusiondirectory-orchestrator/update/supported/index.html -.. _FusionDirectory Orchestrator tags : https://gitlab.fusiondirectory.org/fusiondirectory/fusiondirectory-orchestrator/-/tags -.. _FusionDirectory Orchestrator API : https://gitlab.fusiondirectory.org/applications/fusiondirectory-orchestrator/-/pipelines diff --git a/source/releasing/fusiondirectory-tools.rst b/source/releasing/fusiondirectory-tools.rst deleted file mode 100644 index 48565bc4f3fa46410ca7930714fc039c09dec1c0..0000000000000000000000000000000000000000 --- a/source/releasing/fusiondirectory-tools.rst +++ /dev/null @@ -1,74 +0,0 @@ -How to release a FusionDirectory Tools Version -=============================================== - -- Update the AUTHORS.md file -- Updates the Changelog.md -- Write the upgrade documentation -- Update the UPGRADE.md -- Merge the branch into master - -All those operations have to be made onto a branch each one -of them inside a ticket with the label ~release and with a **MR** - -Update the AUTHORS file -^^^^^^^^^^^^^^^^^^^^^^^ - -Add the authors of all the patchs we received to the AUTHORS file - -:: - - * Markus Amersdorfer <der.plusch@subnet.at> - Wiki setup, Testing, hints, proposals - -Updates the Changelog.md -^^^^^^^^^^^^^^^^^^^^^^^^ - -To update the Changelog.md you must first run the following command, at the end you have to put the milestone you want a changelog for - -.. code:: shell - - gitlab_changelog.py --config-file ~/.python-gitlab.cfg --gitlab fd --project "fusiondirectory/fusiondirectory-tools "FusionDirectory Tools 1.1" - -Update the user documentation -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -open an issue ins the `user manual issues`_ to update the release notes for -the supported version, label this issue ~release and with the correct -milestone - -The content should got into **source/fusiondirectory-tools/update/supported** - -the file should be named like in this example current version to new version - -ex: 1.0-to-1.1.rst - -Update the UPGRADE documentation -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -Update UPGRADE.md with a new section for the new version corresponding -to what you have put into `user manual supported`_ after updating the documentation -for the release - -you can run for example - -.. code:: shell - - pandoc --from rst --to markdown -o 1.0-to-1.1.md 1.0-to-1.1.rst - -directly in the user-manual source to generate the content to copy/paste at the end of UPGRADE.MD - -Merge the branch into master -^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -Only a gitlab master account user can do the merge on the master branch - -Tag the release -^^^^^^^^^^^^^^^ - -After merging the release we need to tag the release. go to `FusionDirectory Tools tags`_ - -- Paste the Changelog.md corresponding to the release we just made - -.. _user manual issues: https://gitlab.fusiondirectory.org/fusiondirectory/user-manual/-/issues -.. _user manual supported : https://fusiondirectory-user-manual.readthedocs.io/en/latest/fusiondirectory/update/supported/index.html -.. _FusionDirectory Tools tags : https://gitlab.fusiondirectory.org/fusiondirectory/fusiondirectory-tools/-/tags diff --git a/source/releasing/fusiondirectory.rst b/source/releasing/fusiondirectory.rst deleted file mode 100644 index a93ff91fc4d9bc20025bd63f9c6c295aecc48831..0000000000000000000000000000000000000000 --- a/source/releasing/fusiondirectory.rst +++ /dev/null @@ -1,111 +0,0 @@ -How to release a FusionDirectory Version -======================================== - -- Updates the locales -- Increment FusionDirectory version -- Update the AUTHORS.md file -- Updates the Changelog.md in fusiondirectory and - fusiondirectory-plugins -- Write the upgrade documentation -- Update the UPGRADE.md -- Merge the branch into master for fusiondirectory and fusiondirectory - plugins - -All those operations have to be made onto a branch each one -of them inside a ticket with the label ~release and with a **MR** - -Updates the locales -^^^^^^^^^^^^^^^^^^^ - -Update the locales from transifex in fusiondirectory and -fusiondirectory-plugins - -.. code:: shell - - tx pull -a -f - -Increment FusionDirectory version -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -open **include/variables_common.inc** - -Change the version number in : - -.. code:: php - - define ("FD_VERSION", "1.2.x"); - -Update the AUTHORS file -^^^^^^^^^^^^^^^^^^^^^^^ - -Add the authors of all the patchs we received to the AUTHORS file - -:: - - * Markus Amersdorfer <der.plusch@subnet.at> - Wiki setup, Testing, hints, proposals - -Updates the Changelog.md -^^^^^^^^^^^^^^^^^^^^^^^^ - -To update the Changelog.md you must first run the following command, at the end you have to put the milestone you want a changelog for - -.. code:: shell - - gitlab_changelog.py --config-file ~/.python-gitlab.cfg --gitlab fd --project "fusiondirectory/fd" --project "fusiondirectory/fd-plugins" "FusionDirectory 1.3.1" - -Update the user documentation -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -open an issue ins the `user manual issues`_ to update the release notes for -the supported version, label this issue ~release and with the correct -milestone - -The content should got into **source/fusiondirectory/update/supported** - -the file should be named like in this example current version to new version - - -1.3-to-1.3.1.rst - -Update the UPGRADE documentation -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -Update UPGRADE.md with a new section for the new version corresponding -to what you have put into `user manual supported`_ after updating the documentation -for the release - -you can run for example - -.. code:: shell - - pandoc --from rst --to markdown -o 1.3-to-1.3.1.md 1.3-to-1.3.1.rst - -directly in the user-manual source to generate the content to copy/paste at the end of UPGRADE.MD - -Merge the branch into master -^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -Only a gitlab master account user can do the merge on the master branch - -Tag the release -^^^^^^^^^^^^^^^ - -After merging the release we need to tag the release. go to `FusionDirectory tags`_ and `FusionDirectory Plugin tags`_ - -- Paste the Changelog.md corresponding to the release we just made - -Run the ci for the schema-history website -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -Once the tags for a release are created in both fusiondirectory and -fusiondirectory-plugins, the CI of schema-history project needs to run -to update the schema website. - -The CI is at `schema history`_ - -.. _user manual issues: https://gitlab.fusiondirectory.org/fusiondirectory/user-manual/-/issues -.. _user manual supported : https://fusiondirectory-user-manual.readthedocs.io/en/latest/fusiondirectory/update/supported/index.html -.. _FusionDirectory tags : https://gitlab.fusiondirectory.org/fusiondirectory/fd/tags -.. _FusionDirectory Plugin tags : https://gitlab.fusiondirectory.org/fusiondirectory/fd-plugins/tags -.. _schema history : https://gitlab.fusiondirectory.org/applications/schema-history diff --git a/source/releasing/index.rst b/source/releasing/index.rst deleted file mode 100644 index a276ac177c351d3b3d73b9c7d84a7b7523162279..0000000000000000000000000000000000000000 --- a/source/releasing/index.rst +++ /dev/null @@ -1,12 +0,0 @@ -Releasing our softwares -======================== - -How to create a release of our various softwares - -.. toctree:: - :maxdepth: 2 - - fusiondirectory.rst - fusiondirectory-integrator.rst - fusiondirectory-orchestrator.rst - fusiondirectory-tools.rst diff --git a/source/security/index.rst b/source/security/index.rst index cbeaf63015db821b61b932a8d8b3a0a7b2b71139..bb77ebfcfad0d8251258494526925e3ae0726da6 100644 --- a/source/security/index.rst +++ b/source/security/index.rst @@ -2,7 +2,6 @@ Security ======== - .. toctree:: :maxdepth: 2