[MOV] developer/misc: move all pages to a more logical location

Before this commit, the "Developer/Misc" directory of the doc, and
more particularly the "Developer/Misc/Other" sub-directory, was used as
a garbage dump where we moved all the pages that didn't fit elsewhere.
Due to that, interesting and important pages, such as the Coding
Guidelines, were buried in that directory never to be read again by Odoo
developers.

This commit moves most pages under "Misc" one or two levels up to be
located directly under "Developer" hence making them more accessible. A
new "Contributing/Development" directory is added to host the Coding
Guidelines page and soon many other pages.

task-2897143

closes odoo/documentation#2368

X-original-commit: 4e67b8986c
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
This commit is contained in:
Antoine Vandevenne (anv) 2022-06-28 14:19:03 +00:00
parent fb86971df9
commit 109817311e
38 changed files with 69 additions and 54 deletions

View File

@ -412,7 +412,7 @@ PostgreSQL login, `dbpassword` is the PostgreSQL password
and `mydb` is the default database to serve on `localhost:8069`.
.. seealso::
- :doc:`The exhaustive list of arguments for odoo-bin </developer/misc/other/cmdline>`.
- :doc:`The exhaustive list of arguments for odoo-bin </developer/cli>`.
Linux
-----
@ -583,7 +583,7 @@ Where `CommunityPath` is the path of the Odoo Community installation
and `mydb` is the default database to serve on `localhost:8069`.
.. seealso::
- :doc:`The exhaustive list of arguments for odoo-bin </developer/misc/other/cmdline>`.
- :doc:`The exhaustive list of arguments for odoo-bin </developer/cli>`.
Mac OS
------
@ -747,7 +747,7 @@ Where `CommunityPath` is the path of the Odoo Community installation
and `mydb` is the default database to serve on `localhost:8069`.
.. seealso::
- :doc:`The exhaustive list of arguments for odoo-bin </developer/misc/other/cmdline>`.
- :doc:`The exhaustive list of arguments for odoo-bin </developer/cli>`.
.. _setup/install/docker:

View File

@ -167,7 +167,7 @@ In the above commands, the argument:
* ``--stop-after-init`` will immediately shutdown the server instance after it completed the operations you asked.
More options are available and detailed in the
:doc:`CLI documentation </developer/misc/other/cmdline>`.
:doc:`CLI documentation </developer/cli>`.
You can find in the logs (*~/logs/odoo.log*) the addons path used by Odoo.sh to run your server.
Look for "*odoo: addons paths*":

View File

@ -42,7 +42,7 @@ instance will be held temporarily unavailable for maintenance reason.
This method is equivalent to perform an upgrade of the module through the Apps menu,
or through the :code:`-u` switch of
:doc:`the command line </developer/misc/other/cmdline>`.
:doc:`the command line </developer/cli>`.
In the case the changes in the commit prevent the server to restart,
or if the modules update fails,

View File

@ -68,4 +68,4 @@ Offering my own services
I am more than welcome to offer my own IAP services through Odoo Apps! It is the perfect opportunity
to get recurring revenue for an ongoing service use rather than — and possibly instead of — a sole
initial purchase. Please, find more information at: :doc:`In-App Purchase
</developer/misc/api/iap>`.
</developer/api/iap>`.

View File

@ -33,7 +33,7 @@ Installation
./odoo-bin --geoip-db= ~/Downloads/GeoLite2-City.mmdb
.. seealso::
- :doc:`CLI documentation </developer/misc/other/cmdline>`.
- :doc:`CLI documentation </developer/cli>`.
.. warning::
``GeoIP`` Python library can also be used. However this version is discontinued since January

View File

@ -1,10 +1,22 @@
:nosearch:
:show-content:
:show-toc:
:hide-page-toc:
============
Contributing
============
First, **thank you** for landing here and helping us improve Odoo!
This documentation section is intended as a guide to making contributions for first-timers and
veterans.
As an open-core project, Odoo accepts contributions from everyone, Odoo employees and members of the
Odoo community alike, in all of its open-source `GitHub repositories
<https://github.com/orgs/odoo/repositories>`_.
.. toctree::
:titlesonly:
contributing/documentation
contributing/development
contributing/documentation

View File

@ -0,0 +1,11 @@
:nosearch:
:hide-page-toc:
===========
Development
===========
.. toctree::
:titlesonly:
development/coding_guidelines

View File

@ -1,11 +1,9 @@
.. highlight:: python
.. _reference/guidelines:
===============
Odoo Guidelines
===============
=================
Coding Guidelines
=================
This page introduces the Odoo Coding Guidelines. Those aim to improve the
quality of Odoo Apps code. Indeed proper code improves readability, eases
@ -238,7 +236,7 @@ The complete tree of our Odoo module therefore looks like
.. warning:: Use correct file permissions : folder 755 and file 644.
.. _reference/guidelines/xml:
.. _contributing/development/xml_guidelines:
XML files
=========
@ -391,7 +389,7 @@ based upon the first one.
...
</record>
.. _reference/guidelines/python:
.. _contributing/development/python_guidelines:
Python
======
@ -950,7 +948,7 @@ Symbols and Conventions
def mail_user_confirm(self):
...
.. _reference/guidelines/js:
.. _contributing/development/js_guidelines:
Javascript and CSS
==================
@ -1012,7 +1010,7 @@ CSS coding guidelines
- Use Bootstrap native classes
- Use underscore lowercase notation to name class
.. _reference/guidelines/git:
.. _contributing/development/git_guidelines:
Git
===

View File

@ -1,8 +1,8 @@
:show-content:
===================
Write documentation
===================
=============
Documentation
=============
.. toctree::
:titlesonly:
@ -11,8 +11,6 @@ Write documentation
documentation/rst_cheat_sheet
documentation/rst_guidelines
**First of all, thank you for landing here and helping us improve the user documentation of Odoo!**
This introductory guide will help you acquire the tools and knowledge you need to write
documentation, whether you plan to make a minor content change or document an application from
scratch.

View File

@ -16,4 +16,6 @@ Learn through tutorials and get help using reference guides.
developer/howtos
developer/reference
developer/misc
developer/api
developer/cli
developer/iot

View File

Before

Width:  |  Height:  |  Size: 16 KiB

After

Width:  |  Height:  |  Size: 16 KiB

View File

Before

Width:  |  Height:  |  Size: 23 KiB

After

Width:  |  Height:  |  Size: 23 KiB

View File

Before

Width:  |  Height:  |  Size: 12 KiB

After

Width:  |  Height:  |  Size: 12 KiB

View File

Before

Width:  |  Height:  |  Size: 12 KiB

After

Width:  |  Height:  |  Size: 12 KiB

View File

Before

Width:  |  Height:  |  Size: 132 KiB

After

Width:  |  Height:  |  Size: 132 KiB

View File

Before

Width:  |  Height:  |  Size: 51 KiB

After

Width:  |  Height:  |  Size: 51 KiB

View File

Before

Width:  |  Height:  |  Size: 6.3 KiB

After

Width:  |  Height:  |  Size: 6.3 KiB

View File

Before

Width:  |  Height:  |  Size: 30 KiB

After

Width:  |  Height:  |  Size: 30 KiB

View File

Before

Width:  |  Height:  |  Size: 15 KiB

After

Width:  |  Height:  |  Size: 15 KiB

View File

Before

Width:  |  Height:  |  Size: 16 KiB

After

Width:  |  Height:  |  Size: 16 KiB

View File

Before

Width:  |  Height:  |  Size: 44 KiB

After

Width:  |  Height:  |  Size: 44 KiB

View File

Before

Width:  |  Height:  |  Size: 23 KiB

After

Width:  |  Height:  |  Size: 23 KiB

View File

Before

Width:  |  Height:  |  Size: 59 KiB

After

Width:  |  Height:  |  Size: 59 KiB

View File

Before

Width:  |  Height:  |  Size: 35 KiB

After

Width:  |  Height:  |  Size: 35 KiB

View File

@ -14,7 +14,8 @@ We will start refactoring the code to match to the Odoo coding guidelines. The g
to improve the quality of the Odoo Apps code.
**Reference**: you will find the Odoo coding guidelines in :ref:`reference/guidelines`.
**Reference**: you will find the Odoo coding guidelines in
:doc:`/contributing/development/coding_guidelines`.
.. exercise:: Polish your code.
@ -88,7 +89,8 @@ Commit your code:
**Everyone reads your commit messages!**
The commit message is very important, follow the :ref:`Developer guidelines <reference/guidelines/git>`.
The commit message is very important, follow the :ref:`Git guidelines
<contributing/development/git_guidelines>`.
Push your new branch to your development repository:

View File

@ -55,7 +55,7 @@ Groups
The documentation related to this topic can be found in :ref:`the security
reference <reference/security>`.
:ref:`The guidelines <reference/guidelines>` document the format and
:doc:`/contributing/development/coding_guidelines` document the format and
location of master data items.
.. admonition:: **Goal**
@ -482,7 +482,7 @@ or a *visibility* feature before using it:
* *Visibility* features mean a user can still access the model or record
otherwise, either through another part of the interface or by :doc:`performing
operations remotely using RPC <../../misc/api/external_api>`, things might just not be
operations remotely using RPC <../../api/external_api>`, things might just not be
visible in the web interface in some contexts.
* *Security* features mean a user can not access records, fields or operations.

View File

@ -1,11 +0,0 @@
:nosearch:
====
Misc
====
.. toctree::
:titlesonly:
misc/api
misc/other

View File

@ -1,12 +0,0 @@
:nosearch:
======
Others
======
.. toctree::
:titlesonly:
other/guidelines
other/cmdline
other/iot

View File

@ -86,7 +86,7 @@
</a>
</li>
<li>
<a href="{{ pathto('developer/misc/api/external_api') }}" class="stretched-link">
<a href="{{ pathto('developer/api/external_api') }}" class="stretched-link">
{{ _("External API") }}
</a>
</li>
@ -97,9 +97,14 @@
<p class="text-muted">{{ _("You want to contribute to Odoo but don't know where to start? The tutorials and guidelines are there to help you make Odoo even better.") }}</p>
<h5 class="text-muted pt-3 text-uppercase fw_semibold">{{ _("Top Links") }}</h5>
<ul class="list-unstyled">
<li>
<a href="{{ pathto('contributing/development/coding_guidelines') }}" class="stretched-link">
{{ _("Coding guidelines") }}
</a>
</li>
<li>
<a href="{{ pathto('contributing/documentation') }}" class="stretched-link">
{{ _("Write documentation") }}
{{ _("Documentation") }}
</a>
</li>
<li>

View File

@ -58,6 +58,16 @@ applications/productivity/discuss/advanced/email_template.rst applications/gener
applications/settings/users_and_features.rst applications/general.rst # settings/users_and_features -> general
# developer/misc
developer/misc/api/iap.rst developer/api/iap.rst # better location for misc/ content (#2337)
developer/misc/api/odoo.rst developer/api/external_api.rst # better location for misc/ content (#2350) /!\ renamed to external_api.rst in 14.0 /!\
developer/misc/i18n/localization.rst developer/howtos/localization.rst # better location for misc/ content (#2337) /!\ already moved in 15.0 /!\
developer/misc/i18n/translations.rst developer/howtos/translations.rst # better location for misc/ content (#2337) /!\ already moved in 15.0 /!\
developer/misc/other/cmdline.rst developer/cli.rst # better location for misc/ content (#2337)
developer/misc/other/guidelines.rst contributing/development/coding_guidelines.rst # better location for misc/ content (#2337)
developer/misc/other/iot.rst developer/iot.rst # better location for misc/ content (#2337)
# services
services/support/supported_versions.rst administration/maintain/supported_versions.rst # services/support/* -> administration/maintain/*

View File

@ -5,7 +5,7 @@ applications/sales/crm/acquire_leads/generate_from_website.rst applications/sale
# developer/misc
developer/misc/api/odoo.rst developer/misc/api/external_api.rst
developer/misc/api/external_api.rst developer/api/external_api.rst # better location for misc/ content (#2350)
# legal