search

OSGP / Documentation

This repository contains documentation for the Open Smart Grid Platform project. This repository is built as a GitBook, therefore all content has to be written using markdown syntax. See the latest GitBook:
https://documentation.gxf.lfenergy.org/
Apache License 2.0
24 stars 15 forks source link

Adding diagram of a global structure of a protocol adapter #237

Closed arjen0203 closed 3 years ago

arjen0203 commented 3 years ago

By adding this figure into the documentation I can properly add it as a source in my protocols design document. Robin den Adel tought it was best if the author approved the commit.

jenkins-ip-10-4-24-184 commented 3 years ago

All is well.

kevinsmeets commented 3 years ago

@arjen0203 I know this image was created by @smvdheijden, but I'm taking over the review of this pull request. You have added this PNG / image file, but you have not created a reference to it in a markdown file. This means the image is not shown, at least, I don't see it in this pull request build of the documentation: https://ci.opensmartgridplatform.org/job/OSGP_Documentation_pr/401/artifact/_book/Protocols/index.html

You are going to need to add something like this example: ![alt text](./gxf-big.png "Grid eXchange Fabric") (I've taken this example from the file https://raw.githubusercontent.com/OSGP/Documentation/development/INTRO.md, have a look at it please.)

jenkins-ip-10-4-24-184 commented 3 years ago

All is well.