[Fiware-ops-dev] Github documentation

[Alessandro Martellone]

Hi Fernando,

more or less both the TOC are similar (I started looking from
https://github.com/telefonicaid/fiware-orion).

They can be a bit different if you are talking about a set of scripts, a
tool by CLI or a more complex application (with a GUI and several software
components).

Honestly from the user/developer point of view is not very clear the
section "Advanced topics". I would suggest being more explicit and rename
the section "How to use it" or something like that.

Regards,
Alessandro

On Wed, Jul 22, 2015 at 8:06 PM, FERNANDO LOPEZ AGUILAR <
fernando.lopezaguilar at telefonica.com> wrote:

>  Dear Silvio,
>
>  I was checking the content that you put like reference in the
> documentation of the
> projects in Github.
>
>  https://github.com/SmartInfrastructures/fuel-main-dev/tree/si/2.0
>
>  And after the checking of the guidelines and some consults to the owner
> of the guide
> that have to be adopted:
>
>
> https://forge.fiware.org/plugins/mediawiki/wiki/fiware/index.php/Developer_Guidelines
>
>  I think that it is more aligned this version of the README file in the
> github.
>
>  https://github.com/telefonicaid/fiware-glancesync/blob/develop/README.md
>
>  In case that you have a component with API documentation, you should add
> a specific
> section like the following content after section "Checking status”,
> nevertheless you can
> discard the following content, how is the case of the glancesync.
>
>  ……
> ## API Overview
>
>  <<<Some example of the API Overview>>>
>
>  Please have a look at the [Quick Start guide](doc/manuals/
> quick_start_guide.md) if you want to test these operations in an actual
> public instance of <<<component>>>. In addition, have a look to the API
> Walkthrough and API Reference sections below in order to know more details
> about the API (..., ..., etc.).
>
>  ## API Walkthrough
>
>  * [blablabla](doc/manuals/user/walkthrough_apiv1.md) (Markdown)
> * [blablabla](<<<link to the apiary>>>) (Apiary) - *ongoing, not yet
> suitable for production*
>
>  ## API Reference Documentation
>
>  * [blabla v1](<<<link to the external document>>>) (XSD and PDF)
> * [blabla v2](<<<link to the apiary document>>>) (Apiary) - *ongoing, not
> yet suitable for production*
> ……
>
>  It is important to notice that it is the minimum common multiple, I mean
> those sections
> have to be described but you are open to include any other sections that
> you understand
> that should be appear in this document.
>
>  If you have any question, please ask me in order to clarify it.
>
>  BR, Fernando.-
>
>
>
> ------------------------------
>
> Este mensaje y sus adjuntos se dirigen exclusivamente a su destinatario,
> puede contener información privilegiada o confidencial y es para uso
> exclusivo de la persona o entidad de destino. Si no es usted. el
> destinatario indicado, queda notificado de que la lectura, utilización,
> divulgación y/o copia sin autorización puede estar prohibida en virtud de
> la legislación vigente. Si ha recibido este mensaje por error, le rogamos
> que nos lo comunique inmediatamente por esta misma vía y proceda a su
> destrucción.
>
> The information contained in this transmission is privileged and
> confidential information intended only for the use of the individual or
> entity named above. If the reader of this message is not the intended
> recipient, you are hereby notified that any dissemination, distribution or
> copying of this communication is strictly prohibited. If you have received
> this transmission in error, do not read it. Please immediately reply to the
> sender that you have received this communication in error and then delete
> it.
>
> Esta mensagem e seus anexos se dirigem exclusivamente ao seu destinatário,
> pode conter informação privilegiada ou confidencial e é para uso exclusivo
> da pessoa ou entidade de destino. Se não é vossa senhoria o destinatário
> indicado, fica notificado de que a leitura, utilização, divulgação e/ou
> cópia sem autorização pode estar proibida em virtude da legislação vigente.
> Se recebeu esta mensagem por erro, rogamos-lhe que nos o comunique
> imediatamente por esta mesma via e proceda a sua destruição
>
> _______________________________________________
> Fiware-ops-dev mailing list
> Fiware-ops-dev at lists.fi-ware.org
> https://lists.fi-ware.org/listinfo/fiware-ops-dev
>
>


-- 


Alessandro M. Martellone



CREATE-NET

Smart Infrastructures Area

Via alla Cascata 56/D

38123 Povo Trento (Italy)



T  (+39) 0461 312437

E  alessandro.martellone at create-net.org

W  www.create-net.org

my agenda <https://www.google.com/calendar/embed?src=amartellone%40create-net.org&ctz=Europe/Rome>
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <https://lists.fiware.org/private/fiware-ops-dev/attachments/20150723/f4e3da41/attachment.html>