User Tools

Site Tools


progetti:cloud-veneto:users_guide:how_to_update_it

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revision Previous revision
Next revision
Previous revision
progetti:cloud-veneto:users_guide:how_to_update_it [2019/07/10 10:14]
sgaravat@infn.it
progetti:cloud-veneto:users_guide:how_to_update_it [2019/07/22 07:35] (current)
sgaravat@infn.it [Update the existing documentation]
Line 1: Line 1:
 ======Users Guide: how to update it====== ======Users Guide: how to update it======
  
-===== Instructions for Ocata ===== 
  
-Till Ocata we use publican ​for the documentation+Since Rocky we use ReadTheDocs ​for the User Guide
  
-=== Prepare your machine === 
  
-The operations reported in this section must be executed only once. +==== Prepare your machine (if needed) ​====
- +
-The following instructions have been tested on SL6 and CentOS7: +
- +
-   * Install publican: +
- +
-<code bash> +
-# yum -y install publican publican-doc +
-</​code>​ +
- +
-   * As user root install the relevant brand and install it: +
- +
-<​code>​ +
-# git clone https://​github.com/​CloudVeneto/​Publican-CloudVeneto-Brand.git +
-# cd publican-CloudVeneto-brand +
-# publican build --formats xml --langs all --publish +
-# publican install_brand --path /​usr/​share/​publican/​Common_Content +
-</​code>​ +
- +
- +
-=== Update the existing documentation === +
- +
-The following operations must be done each time it is necessary to update the user giude. +
-They can be done as normal user +
- +
-   * Download the sources from git: +
- +
-<code bash> +
-$ git clone https://​github.com/​CloudVeneto/​CloudVenetoUsersGuide.git +
-$ cd CloudVenetoUsersGuide +
-</​code>​ +
- +
-   * Do the needed changes (sources are in the ''​en-US''​ subdir) +
-   * Edit the file ''​en-US/​Book_Info.xml''​ and increase the ''​edition''​ number +
-   * Try the build: +
- +
-<code bash> +
-$ publican build --formats=html-desktop,​html --langs=en-US +
-$ publican build --formats=pdf --langs=en-US --config=publican-pdf.cfg +
-</​code>​ +
- +
-   * Check the output in the ''​tmp''​ subdir +
-   * Commit and push your changes +
- +
-=== Publish the updated documentation in the web === +
- +
-<code bash> +
-$ cd tmp/en-US +
- +
-$ rsync -av . root@cld-ctrl-01.cloud:/​var/​www/​Users_Guide/​ +
-$ rsync -av . root@cld-ctrl-02.cloud:/​var/​www/​Users_Guide/​ +
-</​code>​ +
- +
-===== Instructions for Rocky ===== +
- +
- +
-Since Rocky we use ReadTheDocs +
- +
- +
-== Prepare your machine (if needed) ==+
  
 The operations reported in this section must be executed only once. The operations reported in this section must be executed only once.
Line 78: Line 17:
 </​code>​ </​code>​
  
-== Update the existing documentation ==+==== Update the existing documentation ​====
  
 The following operations must be done each time it is necessary to update the user guide. The following operations must be done each time it is necessary to update the user guide.
Line 109: Line 48:
 </​code>​ </​code>​
  
-After a few minutes your changes will be published in https://cloudveneto-userguide.readthedocs.io/​en/​latest/​index.html+After a few minutes your changes will be published in http://​userguide.cloudveneto.it
progetti/cloud-veneto/users_guide/how_to_update_it.1562753685.txt.gz · Last modified: 2019/07/10 10:14 by sgaravat@infn.it