Commit Graph

11 Commits

Author SHA1 Message Date
Antoine Vandevenne (anv)
250bc3ab21 [MOV] content/*: move resource files into their related page's directory
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#2066
2022-05-20 14:48:37 +02:00
Donatienne Pirlot
0cab975494 [ADD] accounting: new doc about outstanding account
Task-id 2744131

closes odoo/documentation#2010

X-original-commit: 5de81c9e2d
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-05-18 12:53:00 +02:00
Jonathan Castillo (jcs)
992ead9e0a [IMP] contributing: modify titles and headings guidelines
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

closes odoo/documentation#1920

X-original-commit: 1997788e81
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
Signed-off-by: Castillo Jonathan (jcs) <jcs@odoo.com>
2022-05-05 14:28:51 +02:00
Antoine Vandevenne (anv)
be1653cc51 [MERGE] Forward-port of branch 13.0 to 14.0 2021-07-07 15:39:35 +02:00
Fabien Pinckaers
16418c020b [IMP] *: introduce tables of contents in top-level app pages 2021-07-07 14:56:38 +02:00
Antoine Vandevenne (anv)
b30f28a3c4 [MERGE] Forward-port of branch 13.0 to 14.0 2021-06-09 12:22:50 +02:00
Antoine Vandevenne (anv)
251438d569 [MERGE] Forward-port of branch 12.0 to 13.0 2021-06-09 12:10:06 +02:00
Victor Feyens
a1e7024fa0 [MERGE] Forward-port of branch 13.0 to 14.0 2021-05-31 15:16:09 +02:00
Victor Feyens
40afc9d9f0 [MERGE] Forward-port of branch 12.0 to 13.0 2021-05-31 14:54:23 +02:00
Antoine Vandevenne (anv)
4b1a61a7aa [MERGE] Forward-port of branch 13.0 to 14.0 2021-05-21 17:21:55 +02:00
Jonathan Castillo
d66de0d1f2 [IMP] accounting: move in-odoo to top-level TOC page + imp structure
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
2021-05-21 17:13:42 +02:00