Commit Graph

10 Commits

Author SHA1 Message Date
Victor Feyens
c60bc5f919 [FIX] *: enforce 1 newline on files end
Part-of: odoo/documentation#2984
2022-11-18 18:04:49 +01:00
Antoine Vandevenne (anv)
8722ea902e [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#2068
2022-05-20 14:18:54 +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
Jonathan Castillo
193e22492c [MERGE] Forward-port of branch 13.0 to 14.0 2021-06-04 17:21:14 +02:00
Jonathan Castillo
2fb77cf3ff [MOV] general: removes main "settings" section + move content
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:
- removes the main "settings" section
  - move its content to general/odoo_basics
- moves "general/mobile" content to "general"
- moves the content of the doc "developer_mode/activate" to "general"
  - it replaces the references to that doc with `:ref:` directives
    rather than `:doc:` directives
  - it is worth noting that it also fixes plenty of links that
    previously referred to "developer_mode" (the category) rather than
	"developer_mode/activate" (the document)

task-2535899
2021-06-04 13:51:18 +02:00
Victor Feyens
8ad392222b [MERGE] Forward-port of branch 13.0 to 14.0 2021-05-17 19:00:31 +02:00
Victor Feyens
87ab494b42 [MERGE] Forward-port of branch 12.0 to 13.0 2021-05-17 18:29:11 +02:00
Antoine Vandevenne (anv)
74c9f94d16 [MERGE] Forward-port of branch 13.0 to 14.0 2021-05-04 16:51:07 +02:00
Antoine Vandevenne (anv)
8a6ad77935 [MERGE] Forward-port of branch 12.0 to 13.0 2021-05-04 16:31:06 +02:00