search

grafana / grafana-app-sdk

An SDK for developing apps for grafana using kubernetes-like storage and operators
Apache License 2.0
44 stars 8 forks source link

Update application design documentation #250

Closed radiohead closed 4 months ago

radiohead commented 4 months ago

WHAT

This commit updates the documentation related to the application design. The new version is more up-to-date, with explanations of the underlying concepts and updated application types.

WHY

To make sure that our documentation is in line with the current vision and development direction of the app platform and the app SDK.

Closes #251

radiohead commented 4 months ago

Could we also include the source for the excalidraw diagrams, to make updating these docs easier in the future?

@IfSentient the source is actually already included. Excalidraw has this neat trick where it can embed the scene into the PNG metadata, so those XXX.excalidraw.png files can be edited in Excalidraw (both web and / or VSCode extension).

Still, if you want me to include the raw metadata files as well let me know and I'll do that!

I've also addressed your comments – feel free to take another look and merge if it looks good to you. Thanks!

IfSentient commented 4 months ago

Could we also include the source for the excalidraw diagrams, to make updating these docs easier in the future?

@IfSentient the source is actually already included. Excalidraw has this neat trick where it can embed the scene into the PNG metadata, so those XXX.excalidraw.png files can be edited in Excalidraw (both web and / or VSCode extension).

Still, if you want me to include the raw metadata files as well let me know and I'll do that!

I've also addressed your comments – feel free to take another look and merge if it looks good to you. Thanks!

Neat, TIL