[FIX] doc: guides section was removed, move CDN to reference
authorXavier Morel <xmo@openerp.com>
Thu, 6 Nov 2014 10:42:02 +0000 (11:42 +0100)
committerXavier Morel <xmo@openerp.com>
Thu, 6 Nov 2014 10:42:02 +0000 (11:42 +0100)
17 files changed:
doc/guides/cdn/keycdn_create_a_pull_zone.png [deleted file]
doc/guides/cdn/keycdn_enable_CORS.png [deleted file]
doc/guides/cdn/keycdn_progressbar.png [deleted file]
doc/guides/cdn/odoo_cdn_base_url.png [deleted file]
doc/guides/cdn/odoo_check_your_html.png [deleted file]
doc/guides/cdn/odoo_font_file_not_loaded.png [deleted file]
doc/guides/cdn/odoo_security_message.png [deleted file]
doc/guides/website_keycdn.rst [deleted file]
doc/reference.rst
doc/reference/cdn.rst [new file with mode: 0644]
doc/reference/cdn/keycdn_create_a_pull_zone.png [new file with mode: 0644]
doc/reference/cdn/keycdn_enable_CORS.png [new file with mode: 0644]
doc/reference/cdn/keycdn_progressbar.png [new file with mode: 0644]
doc/reference/cdn/odoo_cdn_base_url.png [new file with mode: 0644]
doc/reference/cdn/odoo_check_your_html.png [new file with mode: 0644]
doc/reference/cdn/odoo_font_file_not_loaded.png [new file with mode: 0644]
doc/reference/cdn/odoo_security_message.png [new file with mode: 0644]

diff --git a/doc/guides/cdn/keycdn_create_a_pull_zone.png b/doc/guides/cdn/keycdn_create_a_pull_zone.png
deleted file mode 100644 (file)
index ae8d8e2..0000000
Binary files a/doc/guides/cdn/keycdn_create_a_pull_zone.png and /dev/null differ
diff --git a/doc/guides/cdn/keycdn_enable_CORS.png b/doc/guides/cdn/keycdn_enable_CORS.png
deleted file mode 100644 (file)
index f95c240..0000000
Binary files a/doc/guides/cdn/keycdn_enable_CORS.png and /dev/null differ
diff --git a/doc/guides/cdn/keycdn_progressbar.png b/doc/guides/cdn/keycdn_progressbar.png
deleted file mode 100644 (file)
index e40c819..0000000
Binary files a/doc/guides/cdn/keycdn_progressbar.png and /dev/null differ
diff --git a/doc/guides/cdn/odoo_cdn_base_url.png b/doc/guides/cdn/odoo_cdn_base_url.png
deleted file mode 100644 (file)
index e5c7c18..0000000
Binary files a/doc/guides/cdn/odoo_cdn_base_url.png and /dev/null differ
diff --git a/doc/guides/cdn/odoo_check_your_html.png b/doc/guides/cdn/odoo_check_your_html.png
deleted file mode 100644 (file)
index 542afe9..0000000
Binary files a/doc/guides/cdn/odoo_check_your_html.png and /dev/null differ
diff --git a/doc/guides/cdn/odoo_font_file_not_loaded.png b/doc/guides/cdn/odoo_font_file_not_loaded.png
deleted file mode 100644 (file)
index e695261..0000000
Binary files a/doc/guides/cdn/odoo_font_file_not_loaded.png and /dev/null differ
diff --git a/doc/guides/cdn/odoo_security_message.png b/doc/guides/cdn/odoo_security_message.png
deleted file mode 100644 (file)
index 68b860f..0000000
Binary files a/doc/guides/cdn/odoo_security_message.png and /dev/null differ
diff --git a/doc/guides/website_keycdn.rst b/doc/guides/website_keycdn.rst
deleted file mode 100644 (file)
index 383c16a..0000000
+++ /dev/null
@@ -1,73 +0,0 @@
-.. _keycdn-setup:
-
-How to use KeyCDN with Odoo
-===========================
-
-.. sectionauthor:: Fabien Meghazi
-
-This document will guide you through the setup of a KeyCDN account with your
-Odoo powered website.
-
-Step 1: Create a pull zone in the KeyCDN dashboard
---------------------------------------------------
-
-.. image:: cdn/keycdn_create_a_pull_zone.png
-   :class: img-responsive
-
-When creating the zone, enable the CORS option in the `advanced features`
-submenu. (more on that later)
-
-.. image:: cdn/keycdn_enable_CORS.png
-   :class: img-responsive
-
-Once done, you'll have to wait a bit while KeyCDN is crawling your website.
-
-.. image:: cdn/keycdn_progressbar.png
-   :class: img-responsive
-
-Note that an URL has been generated for your Zone.
-In this test case, the URL is `http://pulltest-b49.kxcdn.com`.
-
-
-Step 2: Configure the odoo instance with your zone
---------------------------------------------------
-
-In the Odoo back end, go to the `Website Settings` menu, then activate the CDN
-support and copy/paste your zone URL in the `CDN Base URL` field.
-
-.. image:: cdn/odoo_cdn_base_url.png
-   :class: img-responsive
-
-Now your website is using the CDN for the resources matching the `CDN filters`
-regular expressions.
-
-You can have a look to the HTML of your website in order to check if the CDN
-integration is properly working.
-
-.. image:: cdn/odoo_check_your_html.png
-   :class: img-responsive
-
-
-Why should I activate CORS?
----------------------------
-
-A security restriction in some browsers (Firefox and Chrome at time of writing)
-prevents a remotely linked CSS file to fetch relative resources on this same
-external server.
-
-If you don't activate the CORS option in the CDN zone, the more obvious
-resulting problem on a default Odoo website will be the lack of font-awesome
-icons because the font file declared in the font-awesome CSS won't be loaded on
-the remote server.
-
-Here's what you would see on your homepage in such a case:
-
-.. image:: cdn/odoo_font_file_not_loaded.png
-   :class: img-responsive
-
-A security error message will also appear in the browser's console:
-
-.. image:: cdn/odoo_security_message.png
-   :class: img-responsive
-
-Enabling the CORS option in the CDN fixes this issue.
index 3e1597d..8a09e86 100644 (file)
@@ -20,3 +20,4 @@ Reference
 
     reference/reports
     reference/workflows
+    reference/cdn
diff --git a/doc/reference/cdn.rst b/doc/reference/cdn.rst
new file mode 100644 (file)
index 0000000..76678a1
--- /dev/null
@@ -0,0 +1,79 @@
+========================================
+Deploying with Content Delivery Networks
+========================================
+
+.. _reference/cdn/keycdn:
+
+Deploying with KeyCDN_
+======================
+
+.. sectionauthor:: Fabien Meghazi
+
+This document will guide you through the setup of a KeyCDN_ account with your
+Odoo powered website.
+
+Step 1: Create a pull zone in the KeyCDN dashboard
+--------------------------------------------------
+
+.. image:: cdn/keycdn_create_a_pull_zone.png
+   :class: img-responsive
+
+When creating the zone, enable the CORS option in the
+:guilabel:`advanced features` submenu. (more on that later)
+
+.. image:: cdn/keycdn_enable_CORS.png
+   :class: img-responsive
+
+Once done, you'll have to wait a bit while KeyCDN is crawling your website.
+
+.. image:: cdn/keycdn_progressbar.png
+   :class: img-responsive
+
+.. note:: a new URL has been generated for your Zone, in this case it is
+          ``http://pulltest-b49.kxcdn.com``
+
+Step 2: Configure the odoo instance with your zone
+--------------------------------------------------
+
+In the Odoo back end, go to the :guilabel:`Website Settings`: menu, then
+activate the CDN support and copy/paste your zone URL in the
+:guilabel:`CDN Base URL` field.
+
+.. image:: cdn/odoo_cdn_base_url.png
+   :class: img-responsive
+
+Now your website is using the CDN for the resources matching the
+:guilabel:`CDN filters` regular expressions.
+
+You can have a look to the HTML of your website in order to check if the CDN
+integration is properly working.
+
+.. image:: cdn/odoo_check_your_html.png
+   :class: img-responsive
+
+
+Why should I activate CORS?
+---------------------------
+
+A security restriction in some browsers (Firefox and Chrome at time of writing)
+prevents a remotely linked CSS file to fetch relative resources on this same
+external server.
+
+If you don't activate the CORS option in the CDN zone, the more obvious
+resulting problem on a default Odoo website will be the lack of font-awesome
+icons because the font file declared in the font-awesome CSS won't be loaded on
+the remote server.
+
+Here's what you would see on your homepage in such a case:
+
+.. image:: cdn/odoo_font_file_not_loaded.png
+   :class: img-responsive
+
+A security error message will also appear in the browser's console:
+
+.. image:: cdn/odoo_security_message.png
+   :class: img-responsive
+
+Enabling the CORS option in the CDN fixes this issue.
+
+.. _KeyCDN: https://www.keycdn.com
diff --git a/doc/reference/cdn/keycdn_create_a_pull_zone.png b/doc/reference/cdn/keycdn_create_a_pull_zone.png
new file mode 100644 (file)
index 0000000..ae8d8e2
Binary files /dev/null and b/doc/reference/cdn/keycdn_create_a_pull_zone.png differ
diff --git a/doc/reference/cdn/keycdn_enable_CORS.png b/doc/reference/cdn/keycdn_enable_CORS.png
new file mode 100644 (file)
index 0000000..f95c240
Binary files /dev/null and b/doc/reference/cdn/keycdn_enable_CORS.png differ
diff --git a/doc/reference/cdn/keycdn_progressbar.png b/doc/reference/cdn/keycdn_progressbar.png
new file mode 100644 (file)
index 0000000..e40c819
Binary files /dev/null and b/doc/reference/cdn/keycdn_progressbar.png differ
diff --git a/doc/reference/cdn/odoo_cdn_base_url.png b/doc/reference/cdn/odoo_cdn_base_url.png
new file mode 100644 (file)
index 0000000..e5c7c18
Binary files /dev/null and b/doc/reference/cdn/odoo_cdn_base_url.png differ
diff --git a/doc/reference/cdn/odoo_check_your_html.png b/doc/reference/cdn/odoo_check_your_html.png
new file mode 100644 (file)
index 0000000..542afe9
Binary files /dev/null and b/doc/reference/cdn/odoo_check_your_html.png differ
diff --git a/doc/reference/cdn/odoo_font_file_not_loaded.png b/doc/reference/cdn/odoo_font_file_not_loaded.png
new file mode 100644 (file)
index 0000000..e695261
Binary files /dev/null and b/doc/reference/cdn/odoo_font_file_not_loaded.png differ
diff --git a/doc/reference/cdn/odoo_security_message.png b/doc/reference/cdn/odoo_security_message.png
new file mode 100644 (file)
index 0000000..68b860f
Binary files /dev/null and b/doc/reference/cdn/odoo_security_message.png differ