Skip to content

Commit 91c20a2

Browse files
committed
[MOV] content/*: move resource files into their related page's directory
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
1 parent a658e16 commit 91c20a2

File tree

2,078 files changed

+1805
-1804
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

2,078 files changed

+1805
-1804
lines changed

content/administration/odoo_sh/advanced/containers.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -232,6 +232,6 @@ Save the file and then run the Odoo Shell:
232232
Finally, *via* the Odoo Shell, you can trigger the piece of code/function/method
233233
you want to debug.
234234

235-
.. image:: ./media/pdb_sh.png
235+
.. image:: containers/pdb_sh.png
236236
:align: center
237237
:alt: Console screenshot showing ``pdb`` running in an Odoo.sh shell.

content/administration/odoo_sh/advanced/submodules.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,7 @@ On Odoo.sh, in the branches view of your project, choose the branch in which you
4444

4545
In the upper right corner, click on the *Submodule* button, and then on *Run*.
4646

47-
.. image:: ./media/advanced-submodules-button.png
47+
.. image:: submodules/advanced-submodules-button.png
4848
:align: center
4949

5050
A dialog with a form is shown. Fill the inputs as follows:
@@ -53,12 +53,12 @@ A dialog with a form is shown. Fill the inputs as follows:
5353
* Branch: The branch you want to use.
5454
* Path: The folder in which you want to add this submodule in your branch.
5555

56-
.. image:: ./media/advanced-submodules-dialog.png
56+
.. image:: submodules/advanced-submodules-dialog.png
5757
:align: center
5858

5959
On Github, you can get the repository URL with the *Clone or download* button of the repository. Make sure to *use SSH*.
6060

61-
.. image:: ./media/advanced-submodules-github-sshurl.png
61+
.. image:: submodules/advanced-submodules-github-sshurl.png
6262
:align: center
6363

6464
.. _odoosh-advanced-submodules-withgit:

content/administration/odoo_sh/getting_started/branches.rst

Lines changed: 16 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ Overview
88

99
The branches view gives you an overview of the different branches your repository has.
1010

11-
.. image:: ./media/interface-branches.png
11+
.. image:: branches/interface-branches.png
1212
:align: center
1313

1414
.. _odoosh-gettingstarted-branches-stages:
@@ -20,7 +20,7 @@ Odoo.sh offers three different stages for your branches: production, staging and
2020

2121
You can change the stage of a branch by drag and dropping it into the stage section title.
2222

23-
.. image:: ./media/interface-branches-stagechange.png
23+
.. image:: branches/interface-branches-stagechange.png
2424
:align: center
2525

2626
.. _stage_production:
@@ -109,7 +109,7 @@ Merging your branches
109109
---------------------
110110
You can merge your branches easily by drag and dropping them into each other.
111111

112-
.. image:: ./media/interface-branches-merge.png
112+
.. image:: branches/interface-branches-merge.png
113113
:align: center
114114

115115
When you want to test the changes of your development branches with the production data,
@@ -156,7 +156,7 @@ An overview of your branch history:
156156
* The messages of the commits and their authors,
157157
* The various events linked to the platform, such as stage changes, database imports, backup restores.
158158

159-
.. image:: ./media/interface-branches-history.png
159+
.. image:: branches/interface-branches-history.png
160160
:align: center
161161

162162
For each event, a status is displayed in the top right-hand corner.
@@ -172,7 +172,7 @@ This tab contains the mail catcher. It displays an overview of the emails sent b
172172
The mail catcher is available for your development and
173173
staging branches as the emails of your production database are really sent instead of being intercepted.
174174

175-
.. image:: ./media/interface-branches-mails.png
175+
.. image:: branches/interface-branches-mails.png
176176
:align: center
177177
:scale: 50%
178178

@@ -181,7 +181,7 @@ Shell
181181
A shell access to your container. You can perform basic linux commands (:code:`ls`, :code:`top`)
182182
and open a shell on your database by typing :code:`psql`.
183183

184-
.. image:: ./media/interface-branches-shell.png
184+
.. image:: branches/interface-branches-shell.png
185185
:align: center
186186

187187
You can open multiple tabs and drag-and-drop them to arrange the layout as you wish,
@@ -197,7 +197,7 @@ Editor
197197
An online integrated development environment (IDE) to edit the source code.
198198
You can also open terminals, Python consoles and even Odoo Shell consoles.
199199

200-
.. image:: ./media/interface-branches-editor.png
200+
.. image:: branches/interface-branches-editor.png
201201
:align: center
202202

203203
You can open multiple tabs and drag-and-drop them to arrange the layout as you wish,
@@ -207,7 +207,7 @@ Monitoring
207207
----------
208208
This link contains various monitoring metrics of the current build.
209209

210-
.. image:: ./media/interface-branches-monitoring.png
210+
.. image:: branches/interface-branches-monitoring.png
211211
:align: center
212212

213213
You can zoom, change the time range or select a specific metric on each graph.
@@ -219,7 +219,7 @@ Logs
219219
----
220220
A viewer to have a look to your server logs.
221221

222-
.. image:: ./media/interface-branches-logs.png
222+
.. image:: branches/interface-branches-logs.png
223223
:align: center
224224

225225
Different logs are available:
@@ -243,7 +243,7 @@ Backups
243243
A list of the backups available for download and restore, the ability to perform a manual backup and to import a
244244
database.
245245

246-
.. image:: ./media/interface-branches-backups.png
246+
.. image:: branches/interface-branches-backups.png
247247
:align: center
248248

249249
Odoo.sh makes daily backups of the production database. It keeps 7 daily, 4 weekly and 3 monthly backups.
@@ -285,7 +285,7 @@ Settings
285285
--------
286286
Here you can find a couple of settings that only apply to the currently selected branch.
287287

288-
.. image:: ./media/interface-branches-settings.jpg
288+
.. image:: branches/interface-branches-settings.jpg
289289
:align: center
290290

291291
**Behaviour upon new commit**
@@ -302,7 +302,7 @@ back from staging to development will automatically be set to 'Do nothing'.
302302

303303
Choose the modules to install automatically for your development builds.
304304

305-
.. image:: ./media/interface-settings-modulesinstallation.png
305+
.. image:: branches/interface-settings-modulesinstallation.png
306306
:align: center
307307

308308
* *Install only my modules* will install the modules of the branch only. This is the default option.
@@ -397,7 +397,7 @@ Shell commands
397397
==============
398398
In the top right-hand corner of the view, different shell commands are available.
399399

400-
.. image:: ./media/interface-branches-shellcommands.png
400+
.. image:: branches/interface-branches-shellcommands.png
401401
:align: center
402402

403403
Each command can be copied in the clipboard to be used in a terminal,
@@ -466,12 +466,12 @@ To do so, follow these steps:
466466
(only apply the step 1)
467467
#. Paste the copied content to your profile SSH keys and press "Add"
468468

469-
.. image:: ./media/SSH-key-pasting.png
469+
.. image:: branches/SSH-key-pasting.png
470470
:align: center
471471

472472
#. The key should appear below
473473

474-
.. image:: ./media/SSH-key-appearing.png
474+
.. image:: branches/SSH-key-appearing.png
475475
:align: center
476476

477477
Connection
@@ -485,7 +485,7 @@ To connect to your builds using ssh use the following command in a terminal:
485485
486486
You will find a shortcut for this command into the SSH tab in the upper right corner.
487487

488-
.. image:: ./media/SSH-panel.png
488+
.. image:: branches/SSH-panel.png
489489
:align: center
490490

491491
Provided you have the :ref:`correct access rights <odoosh-gettingstarted-settings-collaborators>` on the project,

0 commit comments

Comments
 (0)