[Fiware-wpl] More on the Architecture document

[Miguel Carrillo]

Dear all,

Extra info. I am getting the feedback from the WPLs that are already generating their Architecture docs. There seems to be a common mistake that needs an explanation. When we specify page names, the name of the links on the cover pages has to be exactly the same as the name of the wiki page - it's an internal rquirement of the script.

Following my example on my original message  (see at the bottom of this e-mail):

Right:

  *   Fiware Public Page         :[http://forge.fi-ware.eu/plugins/mediawiki/wiki/fiware/index.php/FI-WARE_Product_Vision FI-WARE Product Vision]

Wrong

  *   Fiware Public Page         :[http://forge.fi-ware.eu/plugins/mediawiki/wiki/fiware/index.php/FI-WARE_Product_Vision Product Vision ]

As you can see , the 2nd one would cause the script to crash because the name does not match the link URL.

Hope it helps,

Miguel



El 05/03/2013 15:17, Miguel Carrillo escribió:
Dear all,

In the message with the guidelines for the Architecture doc (attached) I promised an email elaborating a bit on the work of creating the docx. Let us recapitulate for your convenience and also add some extra info.

As you may recall, we need to create a cover with the basic info and a list of links. I created the skeleton of what you need on this page on the private wiki: https://forge.fi-ware.eu/plugins/mediawiki/wiki/fi-ware-private/index.php/D.2.3.2.submission_cockpit

You just will use the "partial per chapter contributions" table (a line per chapter) for the time being. I have asked SAP to create a fresh version of the generated zip twice a day (12am and 5 pm). We can refresh it under demand as well but please ask for this just when strictly necessary only

As usual, you need to:

  *   Update the "Structure of this Document"  section with the links
  *   Update other sections as needed (note that they will be merged in the final deliverable unifying all chapters in one doc)
  *   Once the zip is generated, follow the tutorial on https://forge.fi-ware.eu/plugins/mediawiki/wiki/fi-ware-private/index.php/FIWARE.Deliverables.GeneratingDeliverables - this was made by SAP in the past due to time constraints but we need to learn to do it, it is reasonably simple. But yes, it needs some work on your side.  Also, there is a video tutorial on https://forge.fi-ware.eu/docman/view.php/27/1526/FI-WARE_software_deliverable_front_pages.flv. Andreas and Thorsten (in CC) could also help you if you get stuck at some point.

There is very good news. SAP have figured out how to produce documents mixing pages on different wikis. So what I said in my previous emails about having all on the same wiki is not an issue anymore.

You just have to use the following format:
Fiware Public Page         :[URL_TO_PUBLIC_WIKI_PAGE NAME_OF_PUBLIC_WIKI_PAGE]
Fiware Private Page       :[[NAME_OF_PRIVATE_WIKI_PAGE]]
Example:
Fiware Public Page         :[http://forge.fi-ware.eu/plugins/mediawiki/wiki/fiware/index.php/FI-WARE_Product_Vision FI-WARE Product Vision]
Fiware Private Page       :[[Deliverables cockpit]]

Please keep in mind  that only a new document version in the Frontpage (Changes History - {{DocVersion|}}) will lead to a complete regeneration of the deliverable including an update of all linked pictures. If you don't update the document version already cached pictures will be used for document generation.

Best regards,

Miguel


--
----------------------------------------------------------------------
     _/          _/_/                     Miguel Carrillo Pacheco
    _/   _/     _/  _/   Telefónica       Distrito Telefónica
   _/ _/_/_/   _/   _/   Investigación y  Edifico Oeste 1, Planta 4
  _/   _/     _/  _/     Desarrollo       Ronda de la Comunicación S/N
 _/          _/_/                         28050 Madrid (Spain)
                                          Tel:  (+34) 91 483 26 77

                                          e-mail: mcp at tid.es<mailto:mcp at tid.es>

Follow FI-WARE on the net

        Website:  http://www.fi-ware.eu
        Facebook: http://www.facebook.com/pages/FI-WARE/251366491587242
        Twitter:  http://twitter.com/Fiware
        LinkedIn: http://www.linkedin.com/groups/FIWARE-4239932
----------------------------------------------------------------------


--
----------------------------------------------------------------------
     _/          _/_/                     Miguel Carrillo Pacheco
    _/   _/     _/  _/   Telefónica       Distrito Telefónica
   _/ _/_/_/   _/   _/   Investigación y  Edifico Oeste 1, Planta 4
  _/   _/     _/  _/     Desarrollo       Ronda de la Comunicación S/N
 _/          _/_/                         28050 Madrid (Spain)
                                          Tel:  (+34) 91 483 26 77

                                          e-mail: mcp at tid.es<mailto:mcp at tid.es>

Follow FI-WARE on the net

        Website:  http://www.fi-ware.eu
        Facebook: http://www.facebook.com/pages/FI-WARE/251366491587242
        Twitter:  http://twitter.com/Fiware
        LinkedIn: http://www.linkedin.com/groups/FIWARE-4239932
----------------------------------------------------------------------

________________________________

Este mensaje se dirige exclusivamente a su destinatario. Puede consultar nuestra política de envío y recepción de correo electrónico en el enlace situado más abajo.
This message is intended exclusively for its addressee. We only send and receive email on the basis of the terms set out at:
http://www.tid.es/ES/PAGINAS/disclaimer.aspx
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <https://lists.fiware.org/private/fiware-wpl/attachments/20130307/2694c0cd/attachment.html>