-
Notifications
You must be signed in to change notification settings - Fork 10.5k
[MOV] content/*: move resource files into their related page's directory #2026
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Closed
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Collaborator
99c0061 to
1f26fb0
Compare
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
1f26fb0 to
3465475
Compare
The previous file name was not very relevant in regard to the content of the page, and it conflicted with the `sys.path`.
Collaborator
Author
Collaborator
|
Forward-port disabled. |
Collaborator
Author
|
@robodoo rebase-ff |
Collaborator
|
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]>
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]>
Merged
1 task
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
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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.rsthas a reference toimage.pngand todownload.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.rstanddoc2.rst. Doing so prevented us fromfiguring 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 beassigned to both
/some_page\.rstand 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