diff --git a/developer_manual/app/coding-style.rst b/developer_manual/app/coding-style.rst deleted file mode 100644 index 363467bb8..000000000 --- a/developer_manual/app/coding-style.rst +++ /dev/null @@ -1,15 +0,0 @@ -============ -Coding Style -============ - -.. sectionauthor:: Christoph Wurst - -PHP ---- - -Starting with Nextcloud 19 there is a shared `PHP Coding Standards Fixer `_ configuration you can use to automatically format your app's source code. For full details see the `repository on Github `_. - -JavaScript ----------- - -There is a shared configuration for `eslint `_ that you can use to automatically format your Nextcloud apps's JavaScript code. It consists of two parts: a `config package `_ that contains the formatting preferences and a `plugin `_ to detect deprecated and removed APIs in your code. See their readmes for instructions. diff --git a/developer_manual/app/index.rst b/developer_manual/app/index.rst deleted file mode 100644 index 81161bace..000000000 --- a/developer_manual/app/index.rst +++ /dev/null @@ -1,38 +0,0 @@ -=============== -App development -=============== - -.. toctree:: - :maxdepth: 1 - - intro - tutorial - upgrade-guide - bootstrap - npm - javascript-apis - requests/index - view/index - storage/index - changelog - classloader - code_signing - info - init - publishing - users - two-factor-provider - events - backgroundjobs - settings - notifications - flow - logging - repair - publicpage - testing - coding-style - psr - ../api - - diff --git a/developer_manual/app/bootstrap.rst b/developer_manual/app_development/bootstrap.rst similarity index 100% rename from developer_manual/app/bootstrap.rst rename to developer_manual/app_development/bootstrap.rst diff --git a/developer_manual/app_development/index.rst b/developer_manual/app_development/index.rst new file mode 100644 index 000000000..a849e19e4 --- /dev/null +++ b/developer_manual/app_development/index.rst @@ -0,0 +1,13 @@ +=============== +App development +=============== + +.. toctree:: + :maxdepth: 2 + + intro + tutorial + bootstrap + info + init + logging diff --git a/developer_manual/app/info.rst b/developer_manual/app_development/info.rst similarity index 100% rename from developer_manual/app/info.rst rename to developer_manual/app_development/info.rst diff --git a/developer_manual/app/init.rst b/developer_manual/app_development/init.rst similarity index 100% rename from developer_manual/app/init.rst rename to developer_manual/app_development/init.rst diff --git a/developer_manual/app/intro.rst b/developer_manual/app_development/intro.rst similarity index 100% rename from developer_manual/app/intro.rst rename to developer_manual/app_development/intro.rst diff --git a/developer_manual/app/tutorial.rst b/developer_manual/app_development/tutorial.rst similarity index 100% rename from developer_manual/app/tutorial.rst rename to developer_manual/app_development/tutorial.rst diff --git a/developer_manual/app/code_signing.rst b/developer_manual/app_publishing_maintenance/code_signing.rst similarity index 100% rename from developer_manual/app/code_signing.rst rename to developer_manual/app_publishing_maintenance/code_signing.rst diff --git a/developer_manual/app_publishing_maintenance/index.rst b/developer_manual/app_publishing_maintenance/index.rst new file mode 100644 index 000000000..0f4ee0307 --- /dev/null +++ b/developer_manual/app_publishing_maintenance/index.rst @@ -0,0 +1,10 @@ +============================== +App publishing and maintenance +============================== + +.. toctree:: + :maxdepth: 2 + + code_signing + publishing + upgrade-guide diff --git a/developer_manual/app/publishing.rst b/developer_manual/app_publishing_maintenance/publishing.rst similarity index 100% rename from developer_manual/app/publishing.rst rename to developer_manual/app_publishing_maintenance/publishing.rst diff --git a/developer_manual/app/upgrade-guide.rst b/developer_manual/app_publishing_maintenance/upgrade-guide.rst similarity index 100% rename from developer_manual/app/upgrade-guide.rst rename to developer_manual/app_publishing_maintenance/upgrade-guide.rst diff --git a/developer_manual/app/backgroundjobs.rst b/developer_manual/basics/backgroundjobs.rst similarity index 100% rename from developer_manual/app/backgroundjobs.rst rename to developer_manual/basics/backgroundjobs.rst diff --git a/developer_manual/app/requests/controllers.rst b/developer_manual/basics/controllers.rst similarity index 100% rename from developer_manual/app/requests/controllers.rst rename to developer_manual/basics/controllers.rst diff --git a/developer_manual/app/requests/container.rst b/developer_manual/basics/dependency_injection.rst similarity index 99% rename from developer_manual/app/requests/container.rst rename to developer_manual/basics/dependency_injection.rst index 9a2c56294..34890095d 100644 --- a/developer_manual/app/requests/container.rst +++ b/developer_manual/basics/dependency_injection.rst @@ -1,6 +1,6 @@ -========= -Container -========= +==================== +Dependency injection +==================== .. sectionauthor:: Bernhard Posselt diff --git a/developer_manual/app/events.rst b/developer_manual/basics/events.rst similarity index 100% rename from developer_manual/app/events.rst rename to developer_manual/basics/events.rst diff --git a/developer_manual/app/view/css.rst b/developer_manual/basics/front-end/css.rst similarity index 100% rename from developer_manual/app/view/css.rst rename to developer_manual/basics/front-end/css.rst diff --git a/developer_manual/app/view/index.rst b/developer_manual/basics/front-end/index.rst similarity index 71% rename from developer_manual/app/view/index.rst rename to developer_manual/basics/front-end/index.rst index e7dcd1804..925b24570 100644 --- a/developer_manual/app/view/index.rst +++ b/developer_manual/basics/front-end/index.rst @@ -1,6 +1,6 @@ -==== -View -==== +========= +Front-end +========= .. toctree:: :maxdepth: 2 diff --git a/developer_manual/app/view/js.rst b/developer_manual/basics/front-end/js.rst similarity index 100% rename from developer_manual/app/view/js.rst rename to developer_manual/basics/front-end/js.rst diff --git a/developer_manual/app/view/l10n.rst b/developer_manual/basics/front-end/l10n.rst similarity index 100% rename from developer_manual/app/view/l10n.rst rename to developer_manual/basics/front-end/l10n.rst diff --git a/developer_manual/app/view/templates.rst b/developer_manual/basics/front-end/templates.rst similarity index 100% rename from developer_manual/app/view/templates.rst rename to developer_manual/basics/front-end/templates.rst diff --git a/developer_manual/app/view/theming.rst b/developer_manual/basics/front-end/theming.rst similarity index 100% rename from developer_manual/app/view/theming.rst rename to developer_manual/basics/front-end/theming.rst diff --git a/developer_manual/basics/index.rst b/developer_manual/basics/index.rst new file mode 100644 index 000000000..63bcdcd11 --- /dev/null +++ b/developer_manual/basics/index.rst @@ -0,0 +1,17 @@ +============== +Basic concepts +============== + +.. toctree:: + :maxdepth: 2 + + request_lifecycle + routing + dependency_injection + controllers + middlewares + events + front-end/index + backgroundjobs + logging + storage/index \ No newline at end of file diff --git a/developer_manual/app/logging.rst b/developer_manual/basics/logging.rst similarity index 100% rename from developer_manual/app/logging.rst rename to developer_manual/basics/logging.rst diff --git a/developer_manual/app/requests/middleware.rst b/developer_manual/basics/middlewares.rst similarity index 99% rename from developer_manual/app/requests/middleware.rst rename to developer_manual/basics/middlewares.rst index 479530e6f..2777e9635 100644 --- a/developer_manual/app/requests/middleware.rst +++ b/developer_manual/basics/middlewares.rst @@ -1,6 +1,6 @@ -========== -Middleware -========== +=========== +Middlewares +=========== .. sectionauthor:: Bernhard Posselt diff --git a/developer_manual/app/requests/index.rst b/developer_manual/basics/request_lifecycle.rst similarity index 97% rename from developer_manual/app/requests/index.rst rename to developer_manual/basics/request_lifecycle.rst index ee63c2602..d38047ab9 100644 --- a/developer_manual/app/requests/index.rst +++ b/developer_manual/basics/request_lifecycle.rst @@ -5,10 +5,7 @@ Request lifecycle .. toctree:: :maxdepth: 1 - routes - middleware container - controllers api .. sectionauthor:: Bernhard Posselt , Morris Jobke diff --git a/developer_manual/app/requests/routes.rst b/developer_manual/basics/routing.rst similarity index 100% rename from developer_manual/app/requests/routes.rst rename to developer_manual/basics/routing.rst diff --git a/developer_manual/app/storage/appdata.rst b/developer_manual/basics/storage/appdata.rst similarity index 100% rename from developer_manual/app/storage/appdata.rst rename to developer_manual/basics/storage/appdata.rst diff --git a/developer_manual/app/storage/configuration.rst b/developer_manual/basics/storage/configuration.rst similarity index 100% rename from developer_manual/app/storage/configuration.rst rename to developer_manual/basics/storage/configuration.rst diff --git a/developer_manual/app/storage/database.rst b/developer_manual/basics/storage/database.rst similarity index 100% rename from developer_manual/app/storage/database.rst rename to developer_manual/basics/storage/database.rst diff --git a/developer_manual/app/storage/filesystem.rst b/developer_manual/basics/storage/filesystem.rst similarity index 100% rename from developer_manual/app/storage/filesystem.rst rename to developer_manual/basics/storage/filesystem.rst diff --git a/developer_manual/app/storage/index.rst b/developer_manual/basics/storage/index.rst similarity index 100% rename from developer_manual/app/storage/index.rst rename to developer_manual/basics/storage/index.rst diff --git a/developer_manual/app/storage/migrations.rst b/developer_manual/basics/storage/migrations.rst similarity index 100% rename from developer_manual/app/storage/migrations.rst rename to developer_manual/basics/storage/migrations.rst diff --git a/developer_manual/app/storage/schema.rst b/developer_manual/basics/storage/schema.rst similarity index 100% rename from developer_manual/app/storage/schema.rst rename to developer_manual/basics/storage/schema.rst diff --git a/developer_manual/app/testing.rst b/developer_manual/basics/testing.rst similarity index 100% rename from developer_manual/app/testing.rst rename to developer_manual/basics/testing.rst diff --git a/developer_manual/android_library/examples.rst b/developer_manual/client_apis/android_library/examples.rst similarity index 100% rename from developer_manual/android_library/examples.rst rename to developer_manual/client_apis/android_library/examples.rst diff --git a/developer_manual/android_library/index.rst b/developer_manual/client_apis/android_library/index.rst similarity index 93% rename from developer_manual/android_library/index.rst rename to developer_manual/client_apis/android_library/index.rst index 51570952a..c084f8b0b 100644 --- a/developer_manual/android_library/index.rst +++ b/developer_manual/client_apis/android_library/index.rst @@ -1,8 +1,8 @@ .. _androidindex: -=============================== -Android application development -=============================== +======= +Android +======= Nextcloud provides an official Nextcloud Android client, which gives its users access to their files on their Nextcloud. It also includes functionality like automatically uploading pictures and videos to Nextcloud. diff --git a/developer_manual/android_library/library_installation.rst b/developer_manual/client_apis/android_library/library_installation.rst similarity index 100% rename from developer_manual/android_library/library_installation.rst rename to developer_manual/client_apis/android_library/library_installation.rst diff --git a/developer_manual/client_apis/index.rst b/developer_manual/client_apis/index.rst index f87f3fdb0..307ff7a7a 100644 --- a/developer_manual/client_apis/index.rst +++ b/developer_manual/client_apis/index.rst @@ -1,12 +1,13 @@ .. _apiindex: -=============================== -Client APIs -=============================== +======================= +Clients and Client APIs +======================= .. toctree:: :maxdepth: 2 + android_library/index WebDAV/index OCS/index LoginFlow/index diff --git a/developer_manual/api.rst b/developer_manual/digging_deeper/api.rst similarity index 95% rename from developer_manual/api.rst rename to developer_manual/digging_deeper/api.rst index 632f0a0bc..8aba93b01 100644 --- a/developer_manual/api.rst +++ b/developer_manual/digging_deeper/api.rst @@ -1,6 +1,6 @@ .. only:: html - API Documentation + API documentation ================= diff --git a/developer_manual/app/changelog.rst b/developer_manual/digging_deeper/changelog.rst similarity index 100% rename from developer_manual/app/changelog.rst rename to developer_manual/digging_deeper/changelog.rst diff --git a/developer_manual/app/classloader.rst b/developer_manual/digging_deeper/classloader.rst similarity index 100% rename from developer_manual/app/classloader.rst rename to developer_manual/digging_deeper/classloader.rst diff --git a/developer_manual/general/debugging.rst b/developer_manual/digging_deeper/debugging.rst similarity index 100% rename from developer_manual/general/debugging.rst rename to developer_manual/digging_deeper/debugging.rst diff --git a/developer_manual/app/flow.rst b/developer_manual/digging_deeper/flow.rst similarity index 100% rename from developer_manual/app/flow.rst rename to developer_manual/digging_deeper/flow.rst diff --git a/developer_manual/digging_deeper/index.rst b/developer_manual/digging_deeper/index.rst new file mode 100644 index 000000000..a55be91ee --- /dev/null +++ b/developer_manual/digging_deeper/index.rst @@ -0,0 +1,24 @@ +============== +Digging deeper +============== + +.. toctree:: + :maxdepth: 2 + + api + changelog + debugging + classloader + flow + javascript-apis + npm + notifications + performance + psr + publicpage + repair + rest_apis + settings + testing + two-factor-provider + users diff --git a/developer_manual/app/javascript-apis.rst b/developer_manual/digging_deeper/javascript-apis.rst similarity index 100% rename from developer_manual/app/javascript-apis.rst rename to developer_manual/digging_deeper/javascript-apis.rst diff --git a/developer_manual/app/notifications.rst b/developer_manual/digging_deeper/notifications.rst similarity index 100% rename from developer_manual/app/notifications.rst rename to developer_manual/digging_deeper/notifications.rst diff --git a/developer_manual/app/npm.rst b/developer_manual/digging_deeper/npm.rst similarity index 100% rename from developer_manual/app/npm.rst rename to developer_manual/digging_deeper/npm.rst diff --git a/developer_manual/general/performance.rst b/developer_manual/digging_deeper/performance.rst similarity index 100% rename from developer_manual/general/performance.rst rename to developer_manual/digging_deeper/performance.rst diff --git a/developer_manual/app/psr.rst b/developer_manual/digging_deeper/psr.rst similarity index 100% rename from developer_manual/app/psr.rst rename to developer_manual/digging_deeper/psr.rst diff --git a/developer_manual/app/publicpage.rst b/developer_manual/digging_deeper/publicpage.rst similarity index 100% rename from developer_manual/app/publicpage.rst rename to developer_manual/digging_deeper/publicpage.rst diff --git a/developer_manual/app/repair.rst b/developer_manual/digging_deeper/repair.rst similarity index 100% rename from developer_manual/app/repair.rst rename to developer_manual/digging_deeper/repair.rst diff --git a/developer_manual/app/requests/api.rst b/developer_manual/digging_deeper/rest_apis.rst similarity index 98% rename from developer_manual/app/requests/api.rst rename to developer_manual/digging_deeper/rest_apis.rst index 899311db5..636a9ffe9 100644 --- a/developer_manual/app/requests/api.rst +++ b/developer_manual/digging_deeper/rest_apis.rst @@ -1,6 +1,6 @@ -=========== -RESTful API -=========== +========= +REST APIs +========= .. sectionauthor:: Bernhard Posselt diff --git a/developer_manual/app/settings.rst b/developer_manual/digging_deeper/settings.rst similarity index 100% rename from developer_manual/app/settings.rst rename to developer_manual/digging_deeper/settings.rst diff --git a/developer_manual/app/two-factor-provider.rst b/developer_manual/digging_deeper/two-factor-provider.rst similarity index 100% rename from developer_manual/app/two-factor-provider.rst rename to developer_manual/digging_deeper/two-factor-provider.rst diff --git a/developer_manual/app/users.rst b/developer_manual/digging_deeper/users.rst similarity index 100% rename from developer_manual/app/users.rst rename to developer_manual/digging_deeper/users.rst diff --git a/developer_manual/general/index.rst b/developer_manual/general/index.rst deleted file mode 100644 index 04422717c..000000000 --- a/developer_manual/general/index.rst +++ /dev/null @@ -1,13 +0,0 @@ -============================== -General contributor guidelines -============================== - -.. toctree:: - :maxdepth: 2 - - code-of-conduct - devenv - security - codingguidelines - performance - debugging diff --git a/developer_manual/getting_started.rst b/developer_manual/getting_started.rst new file mode 100644 index 000000000..757ca4711 --- /dev/null +++ b/developer_manual/getting_started.rst @@ -0,0 +1,19 @@ +=============== +Getting started +=============== + +Table of contents +----------------- + +.. toctree:: + :maxdepth: 1 + + general/index + app/index + core/index + design/index + android_library/index + client_apis/index + bugtracker/index + commun/index + api diff --git a/developer_manual/general/codingguidelines.rst b/developer_manual/getting_started/codingguidelines.rst similarity index 94% rename from developer_manual/general/codingguidelines.rst rename to developer_manual/getting_started/codingguidelines.rst index c061783db..f69c34c50 100644 --- a/developer_manual/general/codingguidelines.rst +++ b/developer_manual/getting_started/codingguidelines.rst @@ -103,7 +103,7 @@ User interface PHP --- -The Nextcloud coding style guide is based on `PEAR Coding Standards `_. +Starting with Nextcloud 19 there is a shared `PHP Coding Standards Fixer `_ configuration you can use to automatically format your app's source code. For full details see the `repository on Github `_. Always use:: @@ -261,12 +261,10 @@ with ``Data``. JavaScript ---------- -In general take a look at `JSLint `_ without the whitespace rules. +There is a shared configuration for `eslint `_ that you can use to automatically format your Nextcloud apps's JavaScript code. It consists of two parts: a `config package `_ that contains the formatting preferences and a `plugin `_ to detect deprecated and removed APIs in your code. See their readmes for instructions. * Use a :file:`js/main.js` or :file:`js/app.js` where your program is started -* Complete every statement with a **;** -* Use **var** to limit variable to local scope -* To keep your code local, wrap everything in a self executing function. To access global objects or export things to the global namespace, pass all global objects to the self executing function. +* Use **const** or **let** to limit variable to local scope * Use JavaScript strict mode * Use a global namespace object where you bind publicly used functions and objects to diff --git a/developer_manual/getting_started/debugging.rst b/developer_manual/getting_started/debugging.rst new file mode 100644 index 000000000..13c4a68c4 --- /dev/null +++ b/developer_manual/getting_started/debugging.rst @@ -0,0 +1,89 @@ +========= +Debugging +========= + +Debug mode +---------- + +When debug mode is enabled in Nextcloud, a variety of debugging features are enabled - see debugging documentation. Set ``debug`` to ``true`` in :file:`/config/config.php` to enable it: + +.. code-block:: php + + true, + ... configuration goes here ... + ); + + +Identifying errors +------------------ + +Nextcloud uses custom error PHP handling that prevents errors being printed to Web server log files or command line output. Instead, errors are generally stored in Nextcloud's own log file, located at: :file:`/data/nextcloud.log` + + +Debugging variables +------------------- + +You should use exceptions if you need to debug variable values manually, and not alternatives like trigger_error() (which may not be logged). + +e.g.: + +.. code-block:: php + + + +not: + +.. code-block:: php + + + +To disable custom error handling in Nextcloud (and have PHP and your Web server handle errors instead), see Debug mode. + + +Using a PHP debugger (XDebug) +----------------------------- + +Using a debugger connected to PHP allows you to step through code line by line, view variables at each line and even change values while the code is running. The de-facto standard debugger for PHP is XDebug, available as an installable package in many distributions. It just provides the PHP side however, so you will need a frontend to actually control XDebug. When installed, it needs to be enabled in :file:`php.ini`, along with some parameters to enable connections to the debugging interface: + +.. code-block:: ini + + zend_extension=/usr/lib/php/modules/xdebug.so + xdebug.remote_enable=on + xdebug.remote_host=127.0.0.1 + xdebug.remote_port=9000 + xdebug.remote_handler=dbgp + +XDebug will now (when activated) try to connect to localhost on port 9000, and will communicate over the standard protocol DBGP. This protocol is supported by many debugging interfaces, such as the following popular ones: + +- vdebug - Multi-language DBGP debugger client for Vim +- SublimeTextXdebug - XDebug client for Sublime Text +- PHPStorm - in-built DBGP debugger + +For further reading, see the XDebug documentation: http://xdebug.org/docs/remote + +Once you are familiar with how your debugging client works, you can start debugging with XDebug. To test Nextcloud through the web interface or other HTTP requests, set the ``XDEBUG_SESSION_START`` cookie or POST parameter. Alternatively, there are browser extensions to make this easy: + +- The Easiest XDebug (Firefox): https://addons.mozilla.org/en-US/firefox/addon/the-easiest-xdebug/ +- XDebug Helper (Chrome): https://chrome.google.com/extensions/detail/eadndfjplgieldjbigjakmdgkmoaaaoc + +For debugging scripts on the command line, like ``occ`` or unit tests, set the ``XDEBUG_CONFIG`` environment variable. + + +Debugging JavaScript +-------------------- + +By default all JavaScript files in Nextcloud are minified (compressed) into a single file without whitespace. To prevent this, see Debug mode. + + +Debugging HTML and templates +---------------------------- + +By default Nextcloud caches HTML generated by templates. This may prevent changes to app templates, for example, from being applied on page refresh. To disable caching, see Debug mode. + + +Using alternative app directories +--------------------------------- + +It may be useful to have multiple app directories for testing purposes, so you can conveniently switch between different versions of applications. See the configuration file documentation for details. diff --git a/developer_manual/general/devenv.rst b/developer_manual/getting_started/devenv.rst similarity index 100% rename from developer_manual/general/devenv.rst rename to developer_manual/getting_started/devenv.rst diff --git a/developer_manual/getting_started/index.rst b/developer_manual/getting_started/index.rst new file mode 100644 index 000000000..f5fc8759e --- /dev/null +++ b/developer_manual/getting_started/index.rst @@ -0,0 +1,9 @@ +=============== +Getting started +=============== + +.. toctree:: + :maxdepth: 2 + + devenv + codingguidelines diff --git a/developer_manual/index.rst b/developer_manual/index.rst index bdcfc6a12..aa6fea88b 100644 --- a/developer_manual/index.rst +++ b/developer_manual/index.rst @@ -14,12 +14,12 @@ Table of contents .. toctree:: :maxdepth: 2 - general/index - app/index - design/index - android_library/index - client_apis/index + prologue/index + getting_started/index + basics/index + app_development/index core/index - bugtracker/index - commun/index - api + digging_deeper/index + app_publishing_maintenance/index + design/index + client_apis/index diff --git a/developer_manual/bugtracker/codereviews.rst b/developer_manual/prologue/bugtracker/codereviews.rst similarity index 100% rename from developer_manual/bugtracker/codereviews.rst rename to developer_manual/prologue/bugtracker/codereviews.rst diff --git a/developer_manual/bugtracker/index.rst b/developer_manual/prologue/bugtracker/index.rst similarity index 99% rename from developer_manual/bugtracker/index.rst rename to developer_manual/prologue/bugtracker/index.rst index 73cf654f3..207ad9f67 100644 --- a/developer_manual/bugtracker/index.rst +++ b/developer_manual/prologue/bugtracker/index.rst @@ -7,7 +7,6 @@ Bugtracker :hidden: codereviews - kanban triaging Thank you for helping Nextcloud by reporting bugs. Before submitting an issue, please read diff --git a/developer_manual/bugtracker/triaging.rst b/developer_manual/prologue/bugtracker/triaging.rst similarity index 100% rename from developer_manual/bugtracker/triaging.rst rename to developer_manual/prologue/bugtracker/triaging.rst diff --git a/developer_manual/general/code-of-conduct.rst b/developer_manual/prologue/code-of-conduct.rst similarity index 75% rename from developer_manual/general/code-of-conduct.rst rename to developer_manual/prologue/code-of-conduct.rst index 166fb15a4..41e649d1a 100644 --- a/developer_manual/general/code-of-conduct.rst +++ b/developer_manual/prologue/code-of-conduct.rst @@ -1,5 +1,5 @@ -========================= -Community code of conduct -========================= +=============== +Code of conduct +=============== We want the Nextcloud community to be a fun and productive environment for everyone. For that reason, we ask all contributors and participants to familiarize themselves with our `Code of Conduct `_. diff --git a/developer_manual/bugtracker/kanban.rst b/developer_manual/prologue/development_process.rst similarity index 100% rename from developer_manual/bugtracker/kanban.rst rename to developer_manual/prologue/development_process.rst diff --git a/developer_manual/commun/index.rst b/developer_manual/prologue/help_communication.rst similarity index 100% rename from developer_manual/commun/index.rst rename to developer_manual/prologue/help_communication.rst diff --git a/developer_manual/prologue/index.rst b/developer_manual/prologue/index.rst new file mode 100644 index 000000000..d74928762 --- /dev/null +++ b/developer_manual/prologue/index.rst @@ -0,0 +1,13 @@ +======== +Prologue +======== + +.. toctree:: + :maxdepth: 2 + + code-of-conduct + help_communication + bugtracker/index + development_process + security + performance diff --git a/developer_manual/general/security.rst b/developer_manual/prologue/security.rst similarity index 100% rename from developer_manual/general/security.rst rename to developer_manual/prologue/security.rst