7f623b6ad5
Prior to this commit, users had to either know in advance or guess the
location of the content they were looking for. Top-level pages of the
"Developer" section of the documentation, in particular the "Developer"
page itself, were listing their sub-pages without directions for users.
This commit brings the following changes to improve the navigation:
- add directions for users on the "Developer" page and list the three
main categories of developer documentation ("Tutorials", "How-to
guides", and "Reference") with explanations of their content and
target audience;
- add categories for content cards on the "Tutorials" and "How-to
guides" pages, and fine-tune the toctree of the "Reference" page to
more easily locate specific topics;
- clarify what are the "Python framework" and the "JavaScript framework"
by relabelling them to "Server framework" and "Web framework" on
top-level pages, as some users were confused to find that the JS
framework was not responsible for the server, and others that the
documentation for QWeb template is located in the Python documentation;
- extract the "Setup guide" from the "Getting started" tutorial and
rename the latter to "Server framework 101" to allow reusing the setup
guide in other tutorials and make clear that the "Server framework 101"
tutorial is not about the Web framework.
task-3802536
closes odoo/documentation#8597
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
Co-authored-by: Valeriya (vchu) <vchu@odoo.com>
79 lines
3.8 KiB
ReStructuredText
79 lines
3.8 KiB
ReStructuredText
:show-content:
|
|
:hide-page-toc:
|
|
|
|
============
|
|
Contributing
|
|
============
|
|
|
|
First off, **thank you** for landing here and considering contributing to Odoo!
|
|
|
|
This documentation serves as a guide for first-timer and veteran contributors. As an open-core
|
|
project, Odoo accepts contributions from everyone, Odoo employees and members of the Odoo community
|
|
alike. The Odoo community comprises users, developers, and other interested parties who contribute
|
|
their time and expertise.
|
|
|
|
Depending on your skill set and interest, there are many ways to contribute to Odoo. The table below
|
|
lists the most important of them.
|
|
|
|
.. list-table::
|
|
:header-rows: 1
|
|
:stub-columns: 1
|
|
:widths: 20 35 25 20
|
|
|
|
* - Contribution
|
|
- Description
|
|
- Resources
|
|
- Target Audience
|
|
* - Join the community
|
|
- Participate in discussions on the forums, help answer questions, and assist other members of
|
|
the Odoo community.
|
|
- * `Odoo forums <https://www.odoo.com/forum>`_
|
|
- Anyone interested in Odoo
|
|
* - Submit bug reports
|
|
- Help improve the stability of Odoo by reporting the bugs that you discover in :doc:`supported
|
|
versions </administration/supported_versions>` directly to Odoo support. Make sure to include
|
|
as many details (version, environment, test scenario...) as possible. If you don't have the
|
|
Odoo Enterprise license required for contacting the support, open a new issue on the GitHub
|
|
repository of Odoo.
|
|
- * `Odoo support <https://www.odoo.com/help>`_
|
|
* `Issue tracker on GitHub <https://github.com/odoo/odoo/issues>`_
|
|
- Users of Odoo
|
|
* - Translate Odoo
|
|
- Translate the user interface and documentation of Odoo into different languages.
|
|
- * `Odoo project on Transifex <https://explore.transifex.com/odoo/>`_
|
|
- Anyone fluent in multiple languages
|
|
* - Contribute to the codebase
|
|
- Submit pull requests to the Odoo GitHub repositories to fix bugs, add new features, or
|
|
improve the performance and reliability of the product. You can also review and comment on
|
|
pull requests from other contributors. By contributing to the codebase, you can make a direct
|
|
and lasting impact on the quality and features of Odoo.
|
|
- * :doc:`Guide: Contributing to the codebase <contributing/development>`
|
|
* :doc:`Developer tutorials </developer/tutorials>`
|
|
* :doc:`How-to guides </developer/howtos>`
|
|
- Developers with experience in Python and web development
|
|
* - Contribute to the documentation
|
|
- Submit corrections and improvements to the Odoo documentation. The product evolves fast, and
|
|
it can be challenging to consistently reflect these changes in the documentation. By updating
|
|
the documentation, you can help many users find their way in Odoo.
|
|
- * :doc:`Guide: Contributing to the documentation <contributing/documentation>`
|
|
- Anyone interested in improving the Odoo documentation
|
|
* - Create custom modules
|
|
- Develop new modules to extend the functionality of Odoo. Custom modules can be made available
|
|
for free or paid on the Odoo App Store or on any other Odoo modules library. By creating
|
|
custom modules and making them available to others, you can help grow the Odoo ecosystem and
|
|
provide additional value to users of the platform.
|
|
- * `Odoo Apps Store <https://apps.odoo.com/apps>`_
|
|
- Developers with experience in Python and web development
|
|
|
|
.. important::
|
|
It is mainly Odoo employees who develop new features for the codebase and write new content for
|
|
the documentation. Be sure to discuss any idea for a new feature or page with the Odoo team so
|
|
they can give you the green light before you begin working on it. Some features may already be in
|
|
development on their side, and only approved features can be merged.
|
|
|
|
.. toctree::
|
|
:titlesonly:
|
|
|
|
contributing/development
|
|
contributing/documentation
|