Skip to content

Commit

Permalink
🍒 interim docs improvements
Browse files Browse the repository at this point in the history
  • Loading branch information
ruzilia committed Jul 23, 2019
1 parent e58db2a commit d082ce1
Show file tree
Hide file tree
Showing 8 changed files with 167 additions and 112 deletions.
4 changes: 2 additions & 2 deletions odoo_backup_sh/README.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -11,12 +11,12 @@ The 10 Euros service that would save your business.
In-App Purchase
===============

**Odoo-backup.sh** provides a way to store backups in a cloud. Payments for the service is managed by proprietary module, which implements `In-App Purchase <https://www.odoo.com/documentation/12.0/webservices/iap.html>`__ -- payments platform provided by *Odoo S.A.*.
**odoo-backup.sh** provides a way to store backups in a cloud. Payments for the service is managed by proprietary module, which implements `In-App Purchase <https://www.odoo.com/documentation/12.0/webservices/iap.html>`__ -- payments platform provided by *Odoo S.A.*.

Personal cloud
==============

Additionally to the cloud provided by **Odoo-backup.sh** it's possible to store backups on a personal cloud. In that case user has to arrange credentials himself. Supported cloud providers and protocols are as following:
Additionally to the cloud provided by **odoo-backup.sh** it's possible to store backups on a personal cloud. In that case user has to arrange credentials himself. Supported cloud providers and protocols are as following:

* `Dropbox <https://apps.odoo.com/apps/modules/12.0/odoo_backup_sh_dropbox/>`_
* `Google Drive <https://apps.odoo.com/apps/modules/12.0/odoo_backup_sh_google_disk/>`_
Expand Down
Binary file removed odoo_backup_sh/static/description/configuration.png
View file
Binary file not shown.
Binary file removed odoo_backup_sh/static/description/dashboard.png
View file
Binary file not shown.
Binary file removed odoo_backup_sh/static/description/graphs.png
View file
Binary file not shown.
117 changes: 53 additions & 64 deletions odoo_backup_sh/static/description/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
<div class="oe_row oe_spaced">
<div class="oe_span12">
<h2 class="oe_slogan">odoo-backup.sh</h2>
<h3 class="oe_slogan"> The 10 Euros service that would save your business. </h3>
<h3 class="oe_slogan"> The 10 &euro; service that would save your business. </h3>
</div>
</div>
</section>
Expand All @@ -17,25 +17,15 @@ <h3 class="oe_slogan"> The 10 Euros service that would save your business. </h3>

<li>
<i class="fa fa-check-square-o text-primary"></i>
Convenience: <i>smart rotation, graphs, schedule</i>
<b>Convenience:</b> <i>smart rotation, graphs, schedule</i>
</li>

<li>
<i class="fa fa-check-square-o text-primary"></i>
Security: <i>backup encryption</i>
<b>Security:</b> <i>backup encryption</i></b>
</li>

<li>
<i class="fa fa-check-square-o text-primary"></i>
Affordable price: <i>any size before 5GB is 10 Euros, each next 1GB is extra 1 Euros </i>
<ul>
<li>1 GB = 10 Euros</li>
<li>2 GB = 10 Euros</li>
<li>5 GB = 10 Euros</li>
<li>6 GB = 11 Euros</li>
<li>15 GB = 15 Euros</li>
<li>etc.</li>
</ul>
<b>Affordable price:</b> <i>any size before 5 GB will cost 10 &euro;, each next 1 GB - extra 1 &euro;</i></b>
</li>
</ul>
</div>
Expand All @@ -49,64 +39,72 @@ <h3 class="oe_slogan"> The 10 Euros service that would save your business. </h3>
<div class="oe_span12">
<h3 class="oe_slogan">How it works</h3>
<div class="oe_row_img oe_centered" align="center">
<img class="oe_demo oe_picture oe_screenshot" src="dashboard.png"/>
<img class="oe_demo oe_picture oe_screenshot" src=""/>
</div>
<div class="oe_row_img oe_centered" align="center">
<img class="oe_demo oe_picture oe_screenshot" src="graphs.png"/>
<img class="oe_demo oe_picture oe_screenshot" src=""/>
</div>
</div>
<h2 class="oe_slogan">Backups </h2>
<h2 class="oe_slogan">Smart rotation</h2>
<p class="oe_mt32">
<ul>
<li> Open the menu <b>[[ Backups ]] >> Dashboard</b> </li>
<li> After redirection please login in <a href="https://www.dropbox.com/developers/apps"> Odoo.com </a></li>
<li> Set up a new configuration <b>[[ Backups ]] >> Dashboard >> Add Database</b></li>
<li> Choose the Database in the database field</li>
<li> Encrypt your backup if you need, but do not forget the password</li>
<li> Enter <i>Interval Number, Interval Unit, New execution Date</i></li>
<li> Select/unselect <b>Active checkbox</b></li>
<li> Click on <b>Save</b> button </li>
<li> Go to <b>[[ Backups ]] >> Dashboard</b> </li>
<li> Click on <b>New Backup</b> in the appeared configuration </li>
</ul>
<ul>
You can set up along with normal rotation scheme the smart one:
<li> Normal: last 10 backups for 10 days </li>
<li> Smart: last 7 backups for 7 days and 3 backups for last 3 weeks</li>
</ul>
</p>
<div class="oe_row oe_spaced">
<div class="oe_span12">
<div class="oe_row_img oe_centered" align="center">
<img class="oe_demo oe_picture oe_screenshot" src="configuration.png"/>
</div>
</div>

<h2 class="oe_slogan">Restore </h2>
<h2 class="oe_slogan">Schedule</h2>
<p class="oe_mt32">
<ul>
You can set up following time frames:
<li>In the morning, before office hours, in the afternoon, after office hours</li>
<li>Every two hours</li>
<li>At night only</li>
<li>On sunday only</li>
<li><i>and many others depending on your needs</i></li>
</ul>
</p>
<h2 class="oe_slogan">Backup encryption</h2>
<p class="oe_mt32">
<ul>
You should enable the encryption option
<li>Specify a password to protect data in backup files produced by the backup job</li>
<li>Encrypting backups gives you personal control over your personal information</li>
</ul>
</p>
<h2 class="oe_slogan">Graph representation</h2>
<p class="oe_mt32">
<ul>
<li> Please proceed to the Database Manager: <b>/web/database/manager </b> </li>
<li> Click on <b>Restore via Odoo-backup.sh</b> button </li>
<li> Choose the backup that you want to restore</li>
<li> In the open Pop-up window enter <i>Master Password</i>, fill the <i>Database Name</i> </li>
<li> In order to avoid conflicts between databases choose if this database <i>was moved</i> or <i>copied</i> </li>
<li> Click on <b>Continue</b> button</li>
You can monitor and respond for exceptional following situations in time:
<li>backup size has not adequately increased</li>
<li>current backup configuration has not failed</li>
<li>etc.</li>
</ul>
</p>
</div>
</section>

<div class="oe_row oe_spaced">
<div class="oe_span12">
<p class="oe_mt32">
Backup is restored in one click without any additional manipulations such as <i>downloading-uploading</i> process.
</p>
<div class="oe_row_img oe_centered" align="center">
<img class="oe_demo oe_picture oe_screenshot" src="web_db_manager.png"/>
</div>
<p class="oe_mt32">
To use a personal Cloud you need to purchase <a href="https://apps.odoo.com/apps/modules/12.0/odoo_backup_sh_dropbox/">odoo-backup.sh Dropbox</a> and <a href="https://apps.odoo.com/apps/modules/12.0/odoo_backup_sh_google_drive/">odoo-backup.sh Google drive</a> modules.
</p>
</div>
<section class="oe_container">
<div class="oe_row oe_spaced">
<div class="oe_span12">

<div class="alert alert-success oe_mt32" style="padding:0.3em 0.6em; font-size: 150%;">
To use a Personal Cloud you need to purchase <a href="https://apps.odoo.com/apps/modules/12.0/odoo_backup_sh_dropbox/">Dropbox backing up</a> or/and <a href="https://apps.odoo.com/apps/modules/12.0/odoo_backup_sh_google_drive/">Google Drive backing up</a> modules.
</div>

</div>
</div>
</section>

<section class="oe_container">
<div class="oe_row oe_spaced">
<div class="oe_span8">
<h2>Agreements</h2>
<ul>
<li>Read our <i>Terms and Condition</i> <a href="https://odoo-backup.sh/terms">here<i class="fa fa-envelope-o"></i></a></li>
<li><i>Privacy Policy</i> is available <a href="https://odoo-backup.sh/privacy">here<i class="fa fa-envelope-o"></i></a></li>
</ul>
</div>
<div class="oe_span8">
<h2>Need our service?</h2>
<p class="oe_mt32">Contact us by <a href="mailto:apps@it-projects.info">email</a> or fill out <a href="https://www.it-projects.info/page/website.contactus " target="_blank">request form</a></p>
Expand All @@ -117,15 +115,6 @@ <h2>Need our service?</h2>
<li>skype@it-projects.info <i class="fa fa-skype"></i></li>
</ul>
</div>


<div class="oe_span8">
<p class="oe_mt32">
Read our <i>Terms and Condition</i> <a href="https://odoo-backup.sh/terms">here<i class="fa fa-envelope-o"></i></a>.
<i>Privacy Policy</i> is available <a href="https://odoo-backup.sh/privacy">here<i class="fa fa-envelope-o"></i></a>.
</p>
</div>

<div class="oe_span4">
<div class="stamp" style="width:200px;">
<div style="margin-top: 15px;
Expand Down
Binary file removed odoo_backup_sh/static/description/web_db_manager.png
View file
Binary file not shown.
79 changes: 56 additions & 23 deletions odoo_backup_sh_dropbox/static/description/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -17,17 +17,17 @@ <h3 class="oe_slogan">The small investment to protect your business</h3>

<li>
<i class="fa fa-check-square-o text-primary"></i>
Convenience: <i>smart rotation, graphs, schedule</i>
<b>Convenience:</b> <i>smart rotation, graphs, schedule</i>
</li>

<li>
<i class="fa fa-check-square-o text-primary"></i>
Security: <i>backup encryption</i>
<b>Security:</b> <i>backup encryption</i>
</li>

<li>
<i class="fa fa-check-square-o text-primary"></i>
Safe location: <i>your personal Cloud</i>
<b>Safe location:</b> <i>your personal Cloud</i>
</li>
</ul>
</div>
Expand All @@ -36,40 +36,73 @@ <h3 class="oe_slogan">The small investment to protect your business</h3>
</div>
</section>


<section class="oe_container oe_dark">
<div class="oe_row oe_spaced">
<div class="oe_span12">
<h3 class="oe_slogan">How it works</h3>
<p class="oe_mt32">
Go to <b>Backup Dashboard</b> and press <i>Add</i> button
</p>
<div class="oe_row_img oe_centered" align="center">
<img class="oe_demo oe_picture oe_screenshot" src="add_button.png"/>
</div>
<p class="oe_mt32">
Make configuration depending on your needs
</p>
<div class="oe_row_img oe_centered" align="center">
<img class="oe_demo oe_picture oe_screenshot" src="backup_config.png"/>
</div>
<p class="oe_mt32">
You can see details of your backups in the <i>Table format</i>
</p>
<div class="oe_row_img oe_centered" align="center">
<img class="oe_demo oe_picture oe_screenshot" src="backups_table.png"/>
<img class="oe_demo oe_picture oe_screenshot" src=""/>
</div>
<p class="oe_mt32">
You can see a <i>Visual representation</i> of your backups</i>
</p>
<div class="oe_row_img oe_centered" align="center">
<img class="oe_demo oe_picture oe_screenshot" src="dashboard.png"/>
<img class="oe_demo oe_picture oe_screenshot" src=""/>
</div>
</div>
<h2 class="oe_slogan">Dropbox ...</h2>
<p class="oe_mt32">
<ul>
...
<li> </li>
<li> </li>
</ul>
</p>
<h2 class="oe_slogan">Smart rotation</h2>
<p class="oe_mt32">
<ul>
You can set up along with normal rotation scheme the smart one:
<li> Normal: last 10 backups for 10 days </li>
<li> Smart: last 7 backups for 7 days and 3 backups for last 3 weeks</li>
</ul>
</p>
<h2 class="oe_slogan">Schedule</h2>
<p class="oe_mt32">
<ul>
You can set up following time frames:
<li>In the morning, before office hours, in the afternoon, after office hours</li>
<li>Every two hours</li>
<li>At night only</li>
<li>On sunday only</li>
</ul>
</p>
<h2 class="oe_slogan">Backup encryption</h2>
<p class="oe_mt32">
<ul>
You should enable the encryption option
<li>Specify a password to protect data in backup files produced by the backup job</li>
<li>Encrypting backups gives you personal control over your personal information</li>
</ul>
</p>
<h2 class="oe_slogan">Graph representation</h2>
<p class="oe_mt32">
<ul>
You can monitor and respond for exceptional following situations in time:
<li>backup size has not adequately increased</li>
<li>current backup configuration has not failed</li>
<li>etc.</li>
</ul>
</p>
</div>
</section>

<section class="oe_container">
<div class="oe_row oe_spaced">
<div class="oe_span8">
<h2>Agreements</h2>
<ul>
<li>Read our <i>Terms and Condition</i> <a href="https://odoo-backup.sh/terms">here<i class="fa fa-envelope-o"></i></a></li>
<li><i>Privacy Policy</i> is available <a href="https://odoo-backup.sh/privacy">here<i class="fa fa-envelope-o"></i></a></li>
</ul>
</div>
<div class="oe_span8">
<h2>Need our service?</h2>
<p class="oe_mt32">Contact us by <a href="mailto:apps@it-projects.info">email</a> or fill out <a href="https://www.it-projects.info/page/website.contactus " target="_blank">request form</a></p>
Expand Down
Loading

0 comments on commit d082ce1

Please sign in to comment.