all: add archview annotations

[egonelbre]

Make codebase archview compatible. This adds annotations for satellite and storage node.

ArchView allows to visualize code architecture. However, it requires annotations to identify, which parts are important.

Makefile adds two targets make diagrams and make diagrams-graphml.

make diagrams requires GraphViz. As a result it outputs .svg files, this is the quick way to get a visualization.

make diagrams-graphml requires yEd or a similar tool. This will create .graphml files that can be opened in a graph editor and layout there.

The best configuration for yEd has been to use Hierarchical Layout, orientation left-to-right, edges octilinear, and layouting groups. Also you can manually group in yEd based on class or some other criteria.

Please describe the tests:

• Test 1:
• Test 2:

Please describe the performance impact:

Code Review Checklist (to be filled out by reviewer)

• Does the PR describe what changes are being made?
• Does the PR describe why the changes are being made?
• Does the code follow our style guide?
• Does the code follow our testing guide?
• Is the PR appropriately sized? (If it could be broken into smaller PRs it should be)
• Does the new code have enough tests? (every PR should have tests or justification otherwise. Bug-fix PRs especially)
• Does the new code have enough documentation that answers "how do I use it?" and "what does it do?"? (both source documentation and higher level, diagrams?)
• Does any documentation need updating?
• Do the database access patterns make sense?

[egonelbre]

Currently there still might be some things that are mis-classified.

[mobyvb]

Does the linter need to be updated around service/worker/chore/etc... comments?

[egonelbre]

@mobyvb the linter doesn't seem to be complaining.

[mobyvb]

@mobyvb the linter doesn't seem to be complaining.

@egonelbre I guess I meant does the linter need to be updated so that it fails in the future if someone forgets to add an annotation to something that should have it?

[egonelbre]

@mobyvb the issue is that the annotation should only be for relevant architecture types, not all of them. So it would be really hard to create an automatic decision. Otherwise I would have used that algorithm instead of annotations.

[ifraixedes]

I dropped a comment and asked a few questions where I was not clear about the category of the type.