Skip to content

Conversation

@AntoineVDV
Copy link
Collaborator

Since #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

@robodoo
Copy link
Collaborator

robodoo commented May 19, 2022

@AntoineVDV AntoineVDV force-pushed the 14.0-rearrange_media_directories-anv branch 3 times, most recently from 99c0061 to 1f26fb0 Compare May 20, 2022 09:48
Since #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
The previous file name was not very relevant in regard to the content of
the page, and it conflicted with the `sys.path`.
@AntoineVDV
Copy link
Collaborator Author

@fw-bot ignore
@robodoo r+

@fw-bot
Copy link
Collaborator

fw-bot commented May 20, 2022

Forward-port disabled.

@AntoineVDV
Copy link
Collaborator Author

@robodoo rebase-ff

@robodoo
Copy link
Collaborator

robodoo commented May 20, 2022

Merge method set to rebase and fast-forward

robodoo pushed a commit that referenced this pull request May 20, 2022
Since #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: #2026
robodoo pushed a commit that referenced this pull request May 20, 2022
The previous file name was not very relevant in regard to the content of
the page, and it conflicted with the `sys.path`.

closes #2026

Signed-off-by: Antoine Vandevenne (anv) <[email protected]>
@robodoo robodoo closed this May 20, 2022
@robodoo robodoo temporarily deployed to merge May 20, 2022 12:59 Inactive
AntoineVDV added a commit to odoo-dev/odoo that referenced this pull request Jun 21, 2022
The documentation page for the external API was moved elsewhere with PR
odoo/documentation#2026.
robodoo pushed a commit to odoo/odoo that referenced this pull request Jun 21, 2022
The documentation page for the external API was moved elsewhere with PR
odoo/documentation#2026.

closes #94122

Signed-off-by: Antoine Vandevenne (anv) <[email protected]>
AntoineVDV added a commit to odoo-dev/odoo that referenced this pull request Jun 21, 2022
The documentation page for the external API was moved elsewhere with PR
odoo/documentation#2026.

X-original-commit: 08f66aa
robodoo pushed a commit to odoo/odoo that referenced this pull request Jun 21, 2022
The documentation page for the external API was moved elsewhere with PR
odoo/documentation#2026.

closes #94139

X-original-commit: 08f66aa
Signed-off-by: Antoine Vandevenne (anv) <[email protected]>
robodoo pushed a commit to odoo/odoo that referenced this pull request Jun 21, 2022
The documentation page for the external API was moved elsewhere with PR
odoo/documentation#2026.

closes #94139

X-original-commit: 08f66aa
Signed-off-by: Antoine Vandevenne (anv) <[email protected]>
AntoineVDV added a commit to odoo-dev/odoo that referenced this pull request Jun 22, 2022
The documentation page for the external API was moved elsewhere with PR
odoo/documentation#2026.

X-original-commit: e6b4d87
robodoo pushed a commit to odoo/odoo that referenced this pull request Jun 22, 2022
The documentation page for the external API was moved elsewhere with PR
odoo/documentation#2026.

closes #94200

X-original-commit: e6b4d87
Signed-off-by: Antoine Vandevenne (anv) <[email protected]>
royle-vietnam added a commit to Viindoo/branding that referenced this pull request Jun 23, 2022
The documentation page for the external API was moved elsewhere with PR
odoo/documentation#2026
AntoineVDV added a commit to odoo-dev/odoo that referenced this pull request Jun 23, 2022
The documentation page for the external API was moved elsewhere with PR
odoo/documentation#2026.

X-original-commit: 52be3f8
robodoo pushed a commit to odoo/odoo that referenced this pull request Jun 23, 2022
The documentation page for the external API was moved elsewhere with PR
odoo/documentation#2026.

closes #94262

X-original-commit: 52be3f8
Signed-off-by: Antoine Vandevenne (anv) <[email protected]>
AntoineVDV added a commit to odoo-dev/odoo that referenced this pull request Jun 23, 2022
The documentation page for the external API was moved elsewhere with PR
odoo/documentation#2026.

X-original-commit: 5441e66
robodoo pushed a commit to odoo/odoo that referenced this pull request Jun 23, 2022
The documentation page for the external API was moved elsewhere with PR
odoo/documentation#2026.

closes #94402

X-original-commit: 5441e66
Signed-off-by: Antoine Vandevenne (anv) <[email protected]>
AntoineVDV added a commit to odoo-dev/odoo that referenced this pull request Jun 23, 2022
The documentation page for the external API was moved elsewhere with PR
odoo/documentation#2026.

X-original-commit: 9125519
robodoo pushed a commit to odoo/odoo that referenced this pull request Jun 23, 2022
The documentation page for the external API was moved elsewhere with PR
odoo/documentation#2026.

closes #94452

X-original-commit: 9125519
Signed-off-by: Antoine Vandevenne (anv) <[email protected]>
AntoineVDV added a commit to odoo-dev/odoo that referenced this pull request Jun 24, 2022
The documentation page for the external API was moved elsewhere with PR
odoo/documentation#2026.

X-original-commit: 99eb55e
robodoo pushed a commit to odoo/odoo that referenced this pull request Jun 24, 2022
The documentation page for the external API was moved elsewhere with PR
odoo/documentation#2026.

closes #94488

X-original-commit: 99eb55e
Signed-off-by: Antoine Vandevenne (anv) <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants