mirror of
https://github.com/odoo/documentation.git
synced 2026-01-04 10:46:04 +07:00
e3fee2cf46
Prior to this commit, the Odoo documentation was mainly split between
two repositories: odoo/odoo/doc and odoo/documentation-user. Some bits
of documentation were also hosted elsewhere (e.g., wiki, upgrade, ...).
This was causing several problems among which:
- The theme, config, Makefile, and similar technical resources had to
be duplicated. This resulted in inconsistent layout, features, and
build environments from one documentation to another.
- Some pages did not fit either documentation as they were relevant
for both users and developers. Some were relevant to neither of the
two (e.g., DB management).
- Cross-doc references had to be absolute links and they broke often.
- Merging large image files in the developer documentation would bloat
the odoo/odoo repository. Some contributions had to be lightened to
avoid merging too many images (e.g., Odoo development tutorials).
- Long-time contributors to the user documentation were chilly about
going through the merging process of the developer documentation
because of the runbot, mergebot, `odoo-dev` repository, etc.
- Some contributors would look for the developer documentation in the
`odoo/documentation-user` repository.
- Community issues about the user documentation were submitted on the
`odoo/odoo` repository and vice-versa.
Merging all documentations in one repository will allow us to have one
place, one theme, one work process, and one set of tools (build
environment, ...) for all of the Odoo docs.
As this is a good opportunity to revamp the layout of the documentation,
a brand new theme replaces the old one. It features a new way to
navigate the documentation, centered on the idea of always letting the
reader know what is the context (enclosing section, child pages, page
structure ...) of the page they are reading. The previous theme would
quickly confuse readers as they navigated the documentation and followed
cross-application links.
The chance is also taken to get rid of all the technical dangling parts,
performance issues, and left-overs. Except for some page-specific JS
scripts, the Odoo theme Sphinx extension is re-written from scratch
based on the latest Sphinx release to benefit from the improvements and
ease future contributions.
task-2351938
task-2352371
task-2205684
task-2352544
Closes #945
104 lines
3.9 KiB
ReStructuredText
104 lines
3.9 KiB
ReStructuredText
:orphan:
|
||
|
||
.. _list_code_of_conduct:
|
||
|
||
====================================
|
||
Odoo Mailing Lists - Code of Conduct
|
||
====================================
|
||
|
||
.. note:: Version 1 - Last revision: Novembre 16, 2017.
|
||
|
||
Introduction
|
||
============
|
||
|
||
The Odoo community lists are for enthusiast users, partners and developers who
|
||
want to have constructive discussions about Odoo. As the lists have thousands
|
||
of subscribers, this code of conduct aims to ensure a quality discussion for
|
||
everyone.
|
||
|
||
These lists are not systematically reviewed by Odoo staff - while you will see
|
||
responses from staff members from time to time, there are other paid support
|
||
channels available if you require an official response.
|
||
|
||
.. _strive_to:
|
||
|
||
We Strive To
|
||
============
|
||
|
||
1. Be friendly and patient
|
||
|
||
* If someone asks for help it is because they need it. Politely suggest
|
||
specific documentation or more appropriate venues where appropriate.
|
||
Avoid aggressive or vague responses.
|
||
* We all want to live in a positive and friendly environment. Negative
|
||
behaviors and non-constructive criticisms are not allowed.
|
||
|
||
2. Be civil and considerate
|
||
|
||
* Disagreement is no excuse for poor conduct or personal attacks. A
|
||
community where people feel uncomfortable is not a productive one.
|
||
|
||
3. Assume good faith
|
||
|
||
* Remember that technical questions may be very complex. If you disagree,
|
||
please do so politely, by disputing factual premises rather than by
|
||
attacking individuals.
|
||
* If something seems outrageous, check that you did not misinterpret it.
|
||
Ask for clarification, rather than assuming the worst.
|
||
|
||
4. Respect time and attention
|
||
|
||
* List members are busy people. So, we value concision and clarity. Emails
|
||
that are brief and to the point take more time to write, but are repaid
|
||
many times over when other members of the list make the same effort.
|
||
* Avoid talking about the same topics several times, or hijacking other's
|
||
threads.
|
||
* Provide extra valuable information or a question in every reply. (e.g.
|
||
avoid just “Thank you” or “+1” emails)
|
||
|
||
5. Respect the topics
|
||
|
||
* Conversations should remain focused and on-topic. If you must change the
|
||
topic, start a new thread by changing the topic line of your emails.
|
||
Avoid flooding the list with long threads by reading the entire thread
|
||
first, instead of responding quickly to many emails in a short period of
|
||
time.
|
||
* You can not use these mailing lists to advertise your services,
|
||
commercial offers or discuss software other than Odoo. New modules and
|
||
features can be announced on the “Announcements” mailing list only.
|
||
* Don't use the list to report copyright or licenses infringements, report
|
||
issues to abuse@odoo.com instead.
|
||
|
||
6. Don't feed the trolls
|
||
|
||
* Don't get involved in flame wars. Neither post nor respond to incendiary
|
||
material.
|
||
* If you should find yourself in a disagreement with one person, make your
|
||
responses to each other over email rather than continue to send messages
|
||
to the list or the group.
|
||
* Avoid sending messages or posting articles which are no more than
|
||
gratuitous replies to replies.
|
||
|
||
.. _list_enforcement:
|
||
|
||
Enforcement
|
||
===========
|
||
|
||
Experienced members of the Odoo community comply with this code, not because of
|
||
the existence of the code, but because they have long experience participating
|
||
in communities where the conduct described above is normal and expected.
|
||
However, failure to observe the code may be grounds for reprimand, probation,
|
||
or removal from the lists.
|
||
|
||
If you have concerns about someone’s conduct:
|
||
Direct contact: it is always appropriate to email a list member, mention that
|
||
you think their behavior was out of line, and (if necessary) point them to this
|
||
document.
|
||
Moderators: You can reach the list moderators through community-mods@odoo.com
|
||
|
||
|
||
This policy was inspired by
|
||
|
||
* https://opensource.org/codeofconduct/licensing
|
||
* https://www.ietf.org/rfc/rfc1855.txt
|