arch-overview.x

[seinsiedler]

I am currently preparing for the release of a new app.
So i was reading the guide again. In subsection 2.1 I found that I should have a arch-overview.x but apparently this was lost during the development process.

Fromt he requirements and the undefined file ending I assume the desired file is a UML or a combination of UML and text/markdown files.

It is also stated that it should be stored int he {appname} folder and updated with every version, which indicates that it either represents all versions or only the last one.

So I hope that someone could provide an example of the file. Preferably also pointing out its evolution over multiple versions.

[CodeShepherd · Accepted solution]

Moved to corresponding sub forum Other ctrlX World Topics.

The format of the provided file is not fix, so the ".x" was chosen. The information provided should mainly show, how the communication inside and especially to the outside of the snap. So that we as Rexroth know which ports/protocols are used and opened to the outside. The picture will not be part of the app itself but is part of the documentation that needs to be provided beside it.

I tried to create an example:

architecture overview

 

[seinsiedler]

Thank you CodeShepherd,
so it is an UML-like file for the data-flow/interfaces.
Assuming I drop support for an interface in the future. In this example Another.snap in favor of YetAnother.snap. How would we reflect this?
Two files one for each version or one for the newest one.

[CodeShepherd · Accepted solution]

The artifacts delivered by your side only needs to be fitting to the current snap. So if there is a version 1.x using Anothers.API the corresponding file for this needs to be delivered and later on a version 2.x using YetAnothers.API only the valid file needs to be provide. In the documentation/release notes of the snap 2.x the change in the interfaces should be mentioned.