In diesem Artikel werde ich Sie Schritt für Schritt anleiten, um dynamische und interaktive visuelle Dokumentation mit Diagram-as-Code-Tools zu erstellen. Anstelle statischer Bilder generieren wir Diagramme programmgesteuert und stellen so sicher, dass sie immer aktuell und leicht zu warten sind.

Diagram-as-Code: Creating Dynamic and Interactive Documentation for Visual Content

? Diagramm als Code

Diagramm als Code ist ein Ansatz, mit dem Sie Diagramme mithilfe von Code anstelle herkömmlicher Grafiktools erstellen können. Anstatt Diagramme manuell zu erstellen, können Sie Code in eine Textdatei schreiben, um die Struktur, Komponenten und Verbindungen Ihrer Diagramme zu definieren.

Dieser Code wird dann in grafische Bilder übersetzt, was die Integration und Dokumentation in Softwareprojekten erleichtert, wo er besonders nützlich für die programmgesteuerte Erstellung und Aktualisierung von Architektur- und Flussdiagrammen ist.

Was sind Diagramme?

Diagrams ist eine ?Python-Bibliothek, die den Diagram-as-Code-Ansatz implementiert und es Ihnen ermöglicht, architektonische Infrastrukturdiagramme und andere Arten von Diagrammen durch Code zu erstellen. Mit Diagrammen können Sie ganz einfach Cloud-Infrastrukturkomponenten (wie AWS, Azure und GCP), Netzwerkelemente, Softwaredienste und mehr definieren, und das alles mit nur wenigen Codezeilen.

? Vorteile von Diagram-as-Code

? Darstellung von Diagrammen als Code: Erstellen und aktualisieren Sie Diagramme direkt aus dem Code, um die Wartbarkeit in agilen Projekten sicherzustellen.
? Automatisierte Dokumentation: Generieren Sie visuelle Darstellungen aus Code, wobei die Diagramme an der aktuellen Architektur ausgerichtet bleiben.
? Änderungskontrolle: Verfolgen Sie Diagrammänderungen im Laufe der Zeit.
? Verbesserte Klarheit: Verbessern Sie das Verständnis komplexer Systeme mit klaren, gemeinsamen Bildern.
✏️ Anpassbar: Stellen Sie Cloud-Infrastrukturen, Arbeitsabläufe oder Datenpipelines mit flexiblen und maßgeschneiderten Visualisierungen dar.

Anleitung

? Bibliotheksinstallation

Ich habe derzeit Version „0.23.4“ für dieses Tutorial verwendet.

!pip install diagrams=='0.23.4'

Nach dem Login kopieren

? Diagramme: Knoten

Mit der Bibliothek können Sie Architekturdiagramme programmgesteuert erstellen und dabei Knoten verwenden, um verschiedene Infrastrukturkomponenten und -dienste darzustellen.

Knotentypen

Knoten in Diagrammen stellen Komponenten verschiedener Cloud-Dienstanbieter sowie andere Architekturelemente dar. Hier sind die Hauptkategorien der verfügbaren Knoten:

☁️ Cloud-Anbieter: AWS (Amazon Web Services), Azure, GCP, IBM Cloud, Alibaba Cloud, Oracle Cloud, DigitalOcean, unter anderem.
? On-Premise: Stellt die Infrastruktur dar, die sich physisch auf dem Firmengelände befindet.
? Kubernetes (K8S): Container-Orchestrierungssystem zur Automatisierung der Bereitstellung, Skalierung und Verwaltung von Containeranwendungen (dargestellt durch ein Schiffsrad, das Kontrolle und Navigation symbolisiert).
?️ OpenStack: Open-Source-Softwareplattform zum Erstellen und Verwalten öffentlicher und privater Clouds.
? Generisch: Generische Knoten, die jede Komponente darstellen können, die nicht speziell durch anbieterspezifische Knoten abgedeckt wird (gekreuzte Tools, die verschiedene Tools in einer Kategorie darstellen).
☁️ SaaS (Software as a Service): Stellt Anwendungen dar, die als Dienst über das Internet bereitgestellt werden, wie z. B. Snowflake, Chat-Dienste (u. a. Slack, Teams, Telegram), Sicherheit (z. B. Okta ) oder soziale Netzwerke (Telefon und Cloud durchgestrichen für das SaaS-Konzept).
? Benutzerdefiniert: Ermöglicht Benutzern die Anpassung ihrer Diagramme mithilfe von PNG-Symbolen, die in einem bestimmten Ordner gespeichert sind. Dies ist nützlich für die Darstellung von Infrastrukturkomponenten, die nicht von den Standardknoten abgedeckt werden (durchgestrichene benutzerdefinierte Tools).

? Programmiersprachen

Die Diagramme-Bibliothek ermöglicht Ihnen die Verwendung verschiedener Knoten zur Darstellung verschiedener Programmiersprachen. Diese Knoten sind hilfreich, um in Ihren Diagrammen anzugeben, ob ein Teil Ihrer Architektur Skripte oder Komponenten verwendet, die in einer bestimmten Programmiersprache entwickelt wurden.

Im Folgenden stellen wir alle verfügbaren Sprachen in der Bibliothek vor. Wenn eine Sprache fehlt, können Sie benutzerdefinierte Knoten hinzufügen, indem Sie das entsprechende Logo in einen bestimmten Ordner hochladen.

!pip install diagrams=='0.23.4'

Nach dem Login kopieren

Diagram-as-Code: Creating Dynamic and Interactive Documentation for Visual Content

☁️ AWS (Amazon Web Services)

Wir können Amazon-Knoten verwenden, die in mehrere Kategorien unterteilt sind, wie zum Beispiel:

Analytik und Business: aws.analytics, aws.business
Compute und Storage: aws.compute, aws.storage, aws.cost
Datenbank und DevTools: aws.database, aws.devtools
Integration und Management: aws.integration, aws.management
Maschinelles Lernen und Mobil: aws.ml, aws.mobile
Netzwerk und Sicherheit: aws.network, aws.security
Andere: aws.blockchain, aws.enduser, aws.engagement, aws.game, aws.general, aws.iot, aws.media, aws.migration, aws.quantum, aws.robotics, aws. Satellit

Als nächstes stellen wir eine dieser Kategorien dar, um die verfügbaren Knoten in aws.database zu visualisieren.

!pip install diagrams=='0.23.4'

Nach dem Login kopieren

Diagram-as-Code: Creating Dynamic and Interactive Documentation for Visual Content

☁️ Anwendungsfall

Jetzt erstellen wir einen einfachen Entwurf, der dem Import eines Datensatzes und dem Training eines Modells für maschinelles Lernen auf AWS entspricht.

# Create the diagram object
with diagrams.Diagram("Programming Languages", show=False, filename="languages"):
    # Get all the languages available in this library
    languages = [item for item in dir(diagrams.programming.language) if item[0] != '_']

    # Divide the representation in two lines
    mid_index = len(languages) // 2
    first_line = languages[:mid_index]
    second_line = languages[mid_index:]

    # Add nodes in the first row
    prev_node = None

    for language in first_line:
        current_node = eval(f"diagrams.programming.language.{language}(language)")
        if prev_node is not None:
            prev_node >> current_node
        prev_node = current_node

    # Add nodes in the second row
    prev_node = None

    for language in second_line:
        current_node = eval(f"diagrams.programming.language.{language}(language)")
        if prev_node is not None:
            prev_node >> current_node
        prev_node = current_node

Image("languages.png")

Nach dem Login kopieren

Diagram-as-Code: Creating Dynamic and Interactive Documentation for Visual Content

Repository

Unten finden Sie den Link zum gesamten Code. Wenn Sie ihn nützlich finden, können Sie einen Stern hinterlassen ⭐️ und mir folgen, um Benachrichtigungen über neue Artikel zu erhalten. Dies wird mir helfen, in der Tech-Community zu wachsen und mehr Inhalte zu erstellen.

r0mymendez / Diagramm-als-Code

Ein Tutorial zum Erstellen eines Dokumentationsprojekts mit der Methode „Dokument als Diagramm“.

Diagram-as-Code: Creating Dynamic and Interactive Documentation for Visual Content

? Diagramm-als-Code: Erstellen dynamischer und interaktiver Dokumentation für visuelle Inhalte

Diagram-as-Code: Creating Dynamic and Interactive Documentation for Visual Content

Was sind Diagramme?

? Vorteile von Diagram-as-Code

?…

Auf GitHub ansehen

Wenn Sie sehen möchten, wie Sie eine Dokumentationsseite mithilfe dieser Pipeline implementieren, können Sie den Artikel lesen, den ich unter dem folgenden Link veröffentlicht habe

? Referenzen

Diagramme: https://diagrams.mingrammer.com/

Das obige ist der detaillierte Inhalt vonDiagramm als Code: Erstellen dynamischer und interaktiver Dokumentation für visuelle Inhalte. Für weitere Informationen folgen Sie bitte anderen verwandten Artikeln auf der PHP chinesischen Website!