Docs: Add diagrams as code #592
Open
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
davidebriani
added
the
documentation
davidebriani
force-pushed
the
docs/add-diagrams-as-code
branch
3 times, most recently
from
98534e7
to
77a07a2
Compare
|
I think text readability should be improved; maybe making it bold and setting a bigger font size might help? |
davidebriani
force-pushed
the
docs/add-diagrams-as-code
branch
from
77a07a2
to
f0fd362
Compare
davidebriani
force-pushed
the
docs/add-diagrams-as-code
branch
from
f0fd362
to
498a173
Compare
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## master #592 +/- ##
=======================================
Coverage 68.32% 68.32%
=======================================
Files 270 270
Lines 6986 6986
=======================================
Hits 4773 4773
Misses 2213 2213 ☔ View full report in Codecov by Sentry. |
davidebriani
force-pushed
the
docs/add-diagrams-as-code
branch
from
498a173
to
4dda3b6
Compare
Add some initial diagrams: - An overview of the Astarte architecture and how it connects with external services. - A basic sequence diagram describing the process of device registration. - A basic sequence diagram describing the process of device authentication. Signed-off-by: Davide Briani <[email protected]>
Using the D2 Language tooling, define a CI step that compiles the code of the diagrams into images that can be used for documentation purposes and referenced by documentation pages. Signed-off-by: Davide Briani <[email protected]>
davidebriani
force-pushed
the
docs/add-diagrams-as-code
branch
from
4dda3b6
to
6ece675
Compare
Add references to the generated images on appropriate documentation pages, so that diagrams are displayed alongside textual explanations. Signed-off-by: Davide Briani <[email protected]>
davidebriani
force-pushed
the
docs/add-diagrams-as-code
branch
from
6ece675
to
437eac9
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Add pipeline to generate images from diagrams-as-code.
The diagrams are written as code using the D2 Language and compiled into images using the relative tooling so they can be used within documentation pages.
Generated images:
astarte-architecture.svg
astarte-pairing-registration.svg
astarte-pairing-authentication.svg