From df81d02fc42c5773319a2c46a2493b04d896e418 Mon Sep 17 00:00:00 2001 From: Veit Schiele Date: Fri, 5 Jan 2024 17:28:31 +0100 Subject: [PATCH] Update the introduction * Add open source section * Add principles * Remove intro page, move badges to index * Add adoption, compliance and contact * Add GitHub link to toc --- docs/index.rst | 120 +++++++++++++++++++++++++++++++++++++-- docs/intro.rst | 16 ------ docs/resources.rst | 8 +-- docs/writing/testing.rst | 4 +- 4 files changed, 118 insertions(+), 30 deletions(-) delete mode 100644 docs/intro.rst diff --git a/docs/index.rst b/docs/index.rst index 54db452..156ac84 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -1,17 +1,125 @@ ================== -Cusy Design System +cusy Design-System ================== -Das `Cusy Design System `_ besteht -aus Richtlinien für Benutzeroberflächen, Code-Beispielen, Designtools und --Ressourcen. +Das `cusy Design-System `_ ist für +Produkte und digitale Erlebnisse. Es besteht aus funktionierendem Code, +Design-Tools und -Ressourcen und Richtlinien für die Benutzeroberfläche. + +Ein Design-System ist eine Sammlung vorgefertigter, wiederverwendbarer Elemente +– Komponenten, Muster, Anleitungen und Code –, mit denen konsistente digitale +Erlebnisse schneller entwickelt werden können. Durch die Verwendung der +vorgefertigten und universellen Elemente wird die Zeit, die Teams für Design und +Entwicklung aufwenden, minimiert. Anstatt grundlegende Elemente immer wieder neu +zu erstellen, kann die Zeit genutzt werden, um Produkte an spezifische +Kundenbedürfnisse anzupassen. + +Das cusy Design-System ist Open Source +-------------------------------------- + +Das Design-System wird von cusy finanziert und entwickelt, was bedeutet, dass +wir es für unsere geschäftlichen Anforderungen entwickeln. Wir haben es jedoch +zu einem Open-Source-System gemacht, das alle nutzen dürfen und zu dem alle +beitragen können. + +Unsere Leitprinzipien +--------------------- + +offen + Das cusy Design-Sytem ist ein verteiltes Projekt, das sich an den Prinzipien + der Open-Source-Bewegung orientiert. Diejenigen, die das cusy Design-Sytem + nutzen, sind dieselben, die es auch entwickeln. +inklusiv + Das cusy Design-Sytem ist so konzipiert und gebaut, dass es für alle + zugänglich ist, unabhängig von ihren Fähigkeiten oder ihrer Situation. +modular und flexibel + Die Modularität des Systems gewährleistet maximale Flexibilität bei der + Ausführung. Die Komponenten des Systems sind so konzipiert, dass sie nahtlos + ineinander greifen, je nachdem, welche Kombination den Bedürfnissen am + Besten entspricht. +anwendungszentriert + Das cusy Design-Sytem ist anwendungszentriert. Durch die gründliche + Erforschung der Bedürfnisse und Wünsche ist das cusy Design-Sytem auf reale + Menschen ausgerichtet. +konsistent + Jedes Element und jede Komponente des cusy Design-Sytems wurde von Grund auf + so konzipiert, dass es elegant mit anderen Komponenten zusammenarbeitet, um + eine konsistente, kohärente User Experience zu gewährleisten. + +Status +------ + +|Contributors| |Commits| |License| |Docs| |Mastodon| + +.. |Contributors| image:: https://img.shields.io/github/contributors/cusyio/cusy-design-system.svg + :target: https://github.com//cusyio/cusy-design-system/graphs/contributors +.. |Commits| image:: https://raster.shields.io/github/commit-activity/y/cusyio/cusy-design-system + :target: https://github.com//cusyio/cusy-design-system/commits +.. |License| image:: https://img.shields.io/github/license/cusyio/cusy-design-system.svg + :target: https://github.com/cusyio/cusy-design-system/blob/main/LICENSE +.. |Docs| image:: https://readthedocs.org/projects/cusy-design-system/badge/?version=latest + :target: https://cusy-design-system.readthedocs.io/de/latest/ +.. |Mastodon| image:: https://img.shields.io/badge/dynamic/json?label=Mastodon&query=totalItems&url=https%3A%2F%2Fmastodon.social%2F@CusyDesign%2Ffollowers.json&logo=mastodon + :target: https://cusy-design-system.readthedocs.io/de/latest/ + +Wir unterstützen die Adoption +----------------------------- + +Wir führen Schulungen durch und veranstalten Meetings. Wir veranstalten +regelmäßig `Meetups `_ und Design-Reviews. +Außerdem stehen wir als Dozenten auf Konferenzen, in Bootcamps und auch sonst +zur Verfügung. Wir engagieren uns in der Community. Wir streben danach, eines +der besten Design-Systeme der Welt zu sein, und wir sind immer `offen für +Feedback `_. Wir +kommunizieren mit euch über den Status und die Roadmap über `GitHub +`_, `Blogbeiträge +`_ und `Mastodon +`_. Wir bieten auch Unterstützung für +diejenigen, die das cusy Design-System nutzen wollen. + +Design-System-Compliance +------------------------ + +Die Design-System-Compliance ist für die Marke cusy von entscheidender +Bedeutung. Das cusy Design-System ist der digitale Ausdruck der Marke cusy und +das Fundament, auf dem alle Produkte und digitalen Erlebnisse aufgebaut sind. Es +ist die Grundlage für jede digitale Erfahrung, die Menschen während ihrer +Beziehung zu cusy machen. + +Die Schaffung von ansprechenden Benutzererlebnissen, die auf menschenzentriertem +Design, hochwertigen Designstandards und der Marke cusy basieren, stellt sicher, +dass wir konsistente und excellente User Experience bieten und eine Marke +aufbauen, die die Menschen über die gesamte Produktlinie hinweg lieben. + +Kontaktiert uns +--------------- + +Habt ihr Fragen zu unserem Design-System? Habt ihr einen Fehler gefunden? Das +Team des cusy-Design-Sytem ist hier, um euch zu helfen. Bevor ihr beginnt, +solltet ihr euch jedoch die folgenden Ressourcen ansehen, um zu überprüfen, ob +wir eure Frage bereits beantwortet haben. + +Prüft vorhandene Ressourcen +~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +Als ersten Schritt solltet ihr den Inhalt dieser Website zu erkunden. Die +Website ist umfassend und die meisten Leitlinien und Komponenten sind gut +dokumentiert. + +Reicht einen Vorschlag oder Beitrag ein +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +Das Team des cusy Design-System bietet Unterstützung für diejenigen, die das +Design-System nutzen wollen: + +* `GitHub Issues `_ +* `GitHub Pull Requests `_ .. toctree:: :hidden: :titlesonly: :maxdepth: 0 - intro accessibility/index writing/index themes @@ -19,6 +127,8 @@ aus Richtlinien für Benutzeroberflächen, Code-Beispielen, Designtools und viz/index resources genindex + GitHub + .. Indices and tables ================== diff --git a/docs/intro.rst b/docs/intro.rst deleted file mode 100644 index 392a99c..0000000 --- a/docs/intro.rst +++ /dev/null @@ -1,16 +0,0 @@ -Einführung -========== - -Status ------- - -|Contributors| |Commits| |License| |Docs| - -.. |Contributors| image:: https://img.shields.io/github/contributors/cusyio/cusy-design-system.svg - :target: https://github.com//cusyio/cusy-design-system/graphs/contributors -.. |Commits| image:: https://raster.shields.io/github/commit-activity/y/cusyio/cusy-design-system - :target: https://github.com//cusyio/cusy-design-system/commits -.. |License| image:: https://img.shields.io/github/license/cusyio/cusy-design-system.svg - :target: https://github.com/cusyio/cusy-design-system/blob/main/LICENSE -.. |Docs| image:: https://readthedocs.org/projects/cusy-design-system/badge/?version=latest - :target: https://cusy-design-system.readthedocs.io/de/latest/ diff --git a/docs/resources.rst b/docs/resources.rst index 91afdc1..454d8f1 100644 --- a/docs/resources.rst +++ b/docs/resources.rst @@ -4,12 +4,6 @@ Ressourcen Entwicklungsressourcen ---------------------- -GitHub-Repo -~~~~~~~~~~~ - -* `github.com/cusyio/cusy-design-system - `_ - Design-Ressourcen ----------------- @@ -29,7 +23,7 @@ Farben, Raster und Symbole .. todo:: - Cusy-Icon-Bibliothek + cusy-Icon-Bibliothek Werkzeuge --------- diff --git a/docs/writing/testing.rst b/docs/writing/testing.rst index 837cfc2..941ab33 100644 --- a/docs/writing/testing.rst +++ b/docs/writing/testing.rst @@ -20,8 +20,8 @@ Dieses Abzeichen wird vom Dokumentationsserver `Read the Docs Cusy-Design-System veröffentlicht wird, bereitgestellt. Weitere automatisch generierte Abzeichen findet ihr auf unserer Seite -:doc:`../intro` mit Hinweisen zur Anzahl der Mitwirkenden, zur -Aktualisierungshäufigkeit und zur Lizenz. +:doc:`../index` mit Hinweisen zur Anzahl der Mitwirkenden, zur +Aktualisierungshäufigkeit, zur Lizenz und zu Mastodon. Solche Abzeichen lassen sich jedoch nicht nur verwenden um den Status eures Projekts zu dokumentieren, sondern auch um einen stets aktuellen Überblick über