From 27f4677e3bb5ca5845b47d44ac600b3b93030d72 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?David=20Barrag=C3=A1n=20Merino?= Date: Thu, 11 Jul 2024 13:20:02 +0200 Subject: [PATCH] docs: add caution note --- .pre-commit-config.yaml | 6 ++++++ README.md | 15 ++++++++++----- 2 files changed, 16 insertions(+), 5 deletions(-) diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml index 211d6a9..6163cf6 100644 --- a/.pre-commit-config.yaml +++ b/.pre-commit-config.yaml @@ -13,3 +13,9 @@ repos: # Repeating the flag adds this to the list, now [./_templates.gotmpl, README.md.gotmpl] # A base filename makes it relative to each chart directory found - --template-files=README.md.gotmpl + - repo: https://github.com/compilerla/conventional-pre-commit + rev: v3.2.0 + hooks: + - id: conventional-pre-commit + stages: [commit-msg] + args: [] diff --git a/README.md b/README.md index 4f0b180..363ef8b 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,6 @@ +> [!CAUTION] +> This repository is a **work in progress**. Please do **NOT** use this code for production environments. + # Penpot Helm Chart This repository contains the Penpot Helm Chart curated by Penpot. @@ -39,9 +42,11 @@ pre-commit install --install-hooks -f ``` - Access to [http://penpot.example.com/](http://penpot.example.com/) ( - > :exclamation: You need to add `127.0.1.1 penpot.example.com` to `/etc/hosts`_ +> [!NOTE] +> You need to add `127.0.1.1 penpot.example.com` to `/etc/hosts` - > :bulb: if you disable ingress, you can exposing the app in the port 8888 with: - > ```shell - > kubectl port-forward service/penpot 8888:80 - > ``` +> [!TIP] +> if you disable ingress, you can exposing the app in the port 8888 with: +> ```shell +> kubectl port-forward service/penpot 8888:80 +> ```