Since odoo/documentation#903, the guideline for the location of new
resource (images, downloadable files, RST includes...) files is to place
those inside the directory of the RST page that references them.
For example, if `doc1.rst` has a reference to `image.png` and to
`download.zip`, the file structure should look like this:
├── parent_doc/
│ └── doc1/
│ │ └── image.png
│ │ └── download.zip
│ └── doc1.rst
│ └── doc2.rst
├── parent_doc.rst
Before this commit, most of the resource files were still located inside
'media' directories holding all the resource files referenced by RST
pages located at the same level as these directories. In the example
above, a single 'media' directory would hold all the resource files
referenced by both `doc1.rst` and `doc2.rst`. Doing so prevented us from
figuring out easily which resource file was referenced by which RST page
and, thus, lead to unused resource files piling up in the repository. It
also made it more complicated to define codeowners regex rules because a
team could not simply be assigned to `/some_page.*` but needed to be
assigned to both `/some_page\.rst` and to the location of 'media'.
In order to help new content writers figure out the guideline when
taking examples from other RST pages, this commit retroactively applies
the guideline to existing resource files and 'media' directories. The
left-over resource files that are not referenced by any RST page are
removed.
task-2497965
Part-of: odoo/documentation#2064
The previous guidelines for titles and headings included an exception to
capitalize feature names as they are written in the apps. However, this
exception seems to have confused most writers as it isn't always clear
what should be considered as a feature name or what should be considered
as a noun or noun group. This commit removes this exception to make the
writing and reviewing processes easier while retaining good titles and
improving consistency across the documentation. It also changes the
titles of the Accounting section to provide a better example to other
writers.
task-id 2843109
closesodoo/documentation#1912
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
Signed-off-by: Castillo Jonathan (jcs) <jcs@odoo.com>
The "Payment Acquirers" category was moved to the /general/ folder
(Miscellaneous section) when the super-categories such as "Finance"
didn't exist yet. Now, it makes more sense to move this category to
"Finance".
task-id 2743227
Part-of: odoo/documentation#1499
When searching for a string that can be found in a TOC page's content,
that page is listed in the search results. This is not a wanted behavior
because TOC pages without the 'show-content' metadata directive are not
supposed to be accessible.
This commit adds a 'nosearch' metadata directive to all TOC pages
without a 'show-content' metadata directive, hence removing them from
search results.
task-2527419
This commit is part of a larger work to improve the documentation's
structure. The toctree structure used to add levels to create categories
and make the structure visually more understandable.
With the new version of the documentation, plenty of these categories
are now redundant.
This commit improves the structure of the "general" section:
- moves the content of "payment_acquirers/payment_acquirers" to its
parent page, as main content for this category.
It also improves the content of the note about sensitive data.
task-2535899
This commit is part of a larger work to improve the documentation's
structure. The toctree structure used to add levels to create categories
and make the structure visually more understandable.
With the new version of the documentation, plenty of these categories
are now redundant.
This commit improves the structure of the "Accounting" app:
- it moves the doc "in-odoo" in the top "app" level and its content is
included in "accounting.rst" (the content will later be improved)
- adds new intro
- changes external links to mementos to correct doc references
- it renames the category accounting/overview to
accounting/getting_started
- it renames the category accounting/overview/getting_started to
accounting/getting_started/initial_configuration
- it moves "memento" one level above, from
accounting/overview/main_concepts to the renamed
accounting/getting_started as it is the last doc remaining in this
category
- it renames the app "Invoicing and Accounting" to
"Accounting and Invoicing" since the focus should be on "Accounting"
task-2535899
The re sequencing feature done by WAN is perturbing our french customer
In order to explain the reason the feature is, let's state what has been
decided by the product owner (TSB)
opw-2389435
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
