From 0f45e6477f5f4e5283c59142a1eb7fab342f6d8d Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?David=20Barrag=C3=A1n=20Merino?= Date: Mon, 29 Jul 2024 11:21:14 +0200 Subject: [PATCH] docs: minor improvements --- README.md | 5 +++++ charts/penpot/README.md | 18 ++++++++++++++++++ charts/penpot/README.md.gotmpl | 17 +++++++++++++++++ 3 files changed, 40 insertions(+) diff --git a/README.md b/README.md index d786509..7a66635 100644 --- a/README.md +++ b/README.md @@ -35,6 +35,7 @@ We love the Open Source software community. Contributing is our passion and if i If you need help or have any questions; if you’d like to share your experience using Penpot or get inspired; if you’d rather meet our community of developers and designers, [join our Community](https://community.penpot.app/)! You will find the following categories: + - [Ask the Community](https://community.penpot.app/c/ask-for-help-using-penpot/6) - [Troubleshooting](https://community.penpot.app/c/technical/8) - [Help us Improve Penpot](https://community.penpot.app/c/help-us-improve-penpot/7) @@ -50,9 +51,13 @@ You will find the following categories: You can ask and answer questions, have open-ended conversations, and follow along on decisions affecting the project. 💾 [Documentation](https://help.penpot.app/technical-guide/) + 🚀 [Getting Started](https://help.penpot.app/technical-guide/getting-started/) + ✏️ [Tutorials](https://www.youtube.com/playlist?list=PLgcCPfOv5v54WpXhHmNO7T-YC7AE-SRsr) + 🏘️ [Architecture](https://help.penpot.app/technical-guide/developer/architecture/) + 📚 [Dev Diaries](https://penpot.app/dev-diaries.html) diff --git a/charts/penpot/README.md b/charts/penpot/README.md index 26cf20b..565c768 100644 --- a/charts/penpot/README.md +++ b/charts/penpot/README.md @@ -4,6 +4,12 @@ Helm chart for Penpot, the Open Source design and prototyping platform. +## What is Penpot + +Penpot is the first **open-source** design tool for design and code collaboration. Designers can create stunning designs, interactive prototypes, design systems at scale, while developers enjoy ready-to-use code and make their workflow easy and fast. And all of this with no handoff drama. + +Penpot is available on browser and [self host](https://penpot.app/self-host). It’s web-based and works with open standards (SVG, CSS and HTML). And last but not least, it’s free! + ## Installing the Chart To install the chart with the release name `my-release`: @@ -246,3 +252,15 @@ $ helm install my-release penpot/penpot |-----|------|---------|-------------| | redis | object | `{"auth":{"enabled":false}}` | Redis configuration (Check for [more parameters here](https://artifacthub.io/packages/helm/bitnami/redis)) | | redis.auth.enabled | bool | `false` | Whether to enable password authentication. | + +## Resources + +:speaking_head: [Community](https://community.penpot.app) + +:floppy_disk: [Documentation](https://help.penpot.app/) + +:houses: [Architecture](https://help.penpot.app/technical-guide/developer/architecture/) + +:woman_teacher: [Tutorials](https://www.youtube.com/playlist?list=PLgcCPfOv5v54WpXhHmNO7T-YC7AE-SRsr) + +:memo: [Dev Diaries](https://penpot.app/dev-diaries.html) diff --git a/charts/penpot/README.md.gotmpl b/charts/penpot/README.md.gotmpl index 2e7903b..d40b4bb 100644 --- a/charts/penpot/README.md.gotmpl +++ b/charts/penpot/README.md.gotmpl @@ -3,6 +3,14 @@ {{ template "chart.description" . }} + +## What is Penpot + +Penpot is the first **open-source** design tool for design and code collaboration. Designers can create stunning designs, interactive prototypes, design systems at scale, while developers enjoy ready-to-use code and make their workflow easy and fast. And all of this with no handoff drama. + +Penpot is available on browser and [self host](https://penpot.app/self-host). It’s web-based and works with open standards (SVG, CSS and HTML). And last but not least, it’s free! + + ## Installing the Chart To install the chart with the release name `my-release`: @@ -14,3 +22,12 @@ $ helm install my-release penpot/{{ template "chart.name" . }} {{/* {{ template "chart.valuesSectionHtml" . }} */}} {{ template "chart.valuesSection" . }} + + +## Resources + +:speaking_head: [Community](https://community.penpot.app)
+:floppy_disk: [Documentation](https://help.penpot.app/)
+:houses: [Architecture](https://help.penpot.app/technical-guide/developer/architecture/)
+:woman_teacher: [Tutorials](https://www.youtube.com/playlist?list=PLgcCPfOv5v54WpXhHmNO7T-YC7AE-SRsr)
+:memo: [Dev Diaries](https://penpot.app/dev-diaries.html)