From c72a936d5f438685b83f7e6b6750cfe446511d0e Mon Sep 17 00:00:00 2001 From: Stavros Kois <47820033+stavros-k@users.noreply.github.com> Date: Sun, 17 Jul 2022 14:14:52 +0300 Subject: [PATCH] chore(docs): extend linter and apply lint (#3200) * chore(docs): extend linter and apply lint * bump apps to forward docs to websiter --- .markdownlint.yaml | 21 ++++--- charts/incubator/cloudflared/Chart.yaml | 2 +- .../cloudflared/docs/installation_notes.md | 14 ++--- charts/incubator/cloudflareddns/Chart.yaml | 2 +- .../cloudflareddns/docs/setup-guide.md | 11 ++-- cspell.config.yaml | 57 +++++++++---------- 6 files changed, 54 insertions(+), 53 deletions(-) diff --git a/.markdownlint.yaml b/.markdownlint.yaml index 64fbb2a0ee3..d30926b2ff2 100644 --- a/.markdownlint.yaml +++ b/.markdownlint.yaml @@ -1,13 +1,18 @@ -# https://github.com/DavidAnson/markdownlint/blob/main/doc/Rules.md#md033 -# Do not warn for "Inline HTML" -MD033: false +# https://github.com/DavidAnson/markdownlint/blob/main/doc/Rules.md#md004 +# Use dash for "Unordered list style" +MD004: + style: dash -# https://github.com/DavidAnson/markdownlint/blob/v0.25.1/doc/Rules.md#md036 -# Do not warn for "Emphasis used instead of a heading" -MD036: false - -# https://github.com/DavidAnson/markdownlint/blob/v0.25.1/doc/Rules.md#md013 +# https://github.com/DavidAnson/markdownlint/blob/main/doc/Rules.md#md013 # Do not warn for Line length MD013: # We can lower this and wrap lines. Markdown does not care. line_length: 999 + +# https://github.com/DavidAnson/markdownlint/blob/main/doc/Rules.md#md033 +# Do not warn for "Inline HTML" +MD033: false + +# https://github.com/DavidAnson/markdownlint/blob/main/doc/Rules.md#md036 +# Do not warn for "Emphasis used instead of a heading" +MD036: false diff --git a/charts/incubator/cloudflared/Chart.yaml b/charts/incubator/cloudflared/Chart.yaml index 5d7c87e94f7..736c0b49897 100644 --- a/charts/incubator/cloudflared/Chart.yaml +++ b/charts/incubator/cloudflared/Chart.yaml @@ -1,7 +1,7 @@ apiVersion: v2 kubeVersion: ">=1.16.0-0" name: cloudflared -version: 0.0.15 +version: 0.0.16 appVersion: "2022.7.1" description: Client for Cloudflare Tunnel, a daemon that exposes private services through the Cloudflare edge. type: application diff --git a/charts/incubator/cloudflared/docs/installation_notes.md b/charts/incubator/cloudflared/docs/installation_notes.md index c0b0b0954ce..708d7506bb1 100644 --- a/charts/incubator/cloudflared/docs/installation_notes.md +++ b/charts/incubator/cloudflared/docs/installation_notes.md @@ -1,16 +1,16 @@ # Installation Notes -* Go to [cloudflare team dash](https://dash.teams.cloudflare.com) +- Go to [cloudflare team dash](https://dash.teams.cloudflare.com) and create a tunnel or migrate a current tunnel(this action is not reversible) -* copy the token from tunnel's overview **Install and run a connector** section +- Copy the token from tunnel's overview **Install and run a connector** section, this is what your token may look like. -```console -eyJhIjoiNDJhYmYwMTQzNGMyMeUzNDMzMTE1Y2M0YmFhZGY0YTciLCJ0IjoiNzBiNza5zTItMWViMS00MjdjaWFiZjEtZWMwdzIwNmQwZmI3IiwicyI6IlltRmxPV1ExTldZdE16a3lOUzAwsW1KbUxUZzJPVGN0Wm1VelptVmpaak00T1dZeiJ5 -``` + ```text + eyJhIjoiNDJhYmYwMTQzNGMyMeUzNDMzMTE1Y2M0YmFhZGY0YTciLCJ0IjoiNzBiNza5zTItMWViMS00MjdjaWFiZjEtZWMwdzIwNmQwZmI3IiwicyI6IlltRmxPV1ExTldZdE16a3lOUzAwsW1KbUxUZzJPVGN0Wm1VelptVmpaak00T1dZeiJ5 + ``` -* set `token` with **your** tunnel's token +- Set `token` with **your** tunnel's token -* Now you can manage the tunnel via cloudflare dash by setting a private network or create ingress rules for your services and domain. +- Now you can manage the tunnel via cloudflare dash by setting a private network or create ingress rules for your services and domain. diff --git a/charts/incubator/cloudflareddns/Chart.yaml b/charts/incubator/cloudflareddns/Chart.yaml index 6ff85366eed..8c07965fd49 100644 --- a/charts/incubator/cloudflareddns/Chart.yaml +++ b/charts/incubator/cloudflareddns/Chart.yaml @@ -1,7 +1,7 @@ apiVersion: v2 kubeVersion: ">=1.16.0-0" name: cloudflareddns -version: 0.0.15 +version: 0.0.16 appVersion: "latest" description: Update your Cloudflare DNS records using dynamically type: application diff --git a/charts/incubator/cloudflareddns/docs/setup-guide.md b/charts/incubator/cloudflareddns/docs/setup-guide.md index 963bdd61a41..2544d444d52 100644 --- a/charts/incubator/cloudflareddns/docs/setup-guide.md +++ b/charts/incubator/cloudflareddns/docs/setup-guide.md @@ -1,14 +1,15 @@ # How-To -So you've followed some of our TrueNAS guides, setup your domain name, certificates and use Cloudflare for your DNS management, however you don't have a static IP, then this guide is for you. This quick guide will help you go through the steps to use Cloudflareddns to update your dynamic IP along with your entire deployment so that even if you change IP your domain will point to the right address. +So you've followed some of our TrueNAS guides, setup your domain name, certificates and use Cloudflare for your DNS management, however you don't have a static IP, then this guide is for you. This quick guide will help you go through the steps to use Cloudflareddns to update your dynamic IP along with your entire deployment so that even if you change IP your domain will point to the right address. ## Requirements Domain name (can be purchased through Cloudflare or etc) Cloudflare DNS management - - Sign up for Cloudflare free - - Point your nameservers to the ones Cloudflare assigns to you + +- Sign up for Cloudflare free +- Point your nameservers to the ones Cloudflare assigns to you ![image](https://user-images.githubusercontent.com/89483932/179332161-e903e46e-ed8c-4b58-81fc-6fcadf1a9851.png) Cloudflareddns chart @@ -25,7 +26,6 @@ Take note of the `Zone ID` and `Account ID`, that's what we'll use inside the Cl ![Overview](https://user-images.githubusercontent.com/89483932/179336819-64a32521-c64b-4ae6-8d5d-225b7342b786.png) - ## Cloudflareddns chart setup Step 1-2: Name chart and leave defaults for Step 2 @@ -53,9 +53,8 @@ Steps 4-8: Adjust as necessary but defaults are fine - If you need more details or have a more custom setup the documentation on the upstream chart (https://hotio.dev/containers/cloudflareddns/) is very complete so check the descriptions of the options there. - You can also reach us using Discord for real-time feedback and support - Check our [Discord](https://discord.gg/tVsPTHWTtr) -- If yoOpen a [issue](https://github.com/truecharts/apps/issues/new/choose) +- If you found a bug in our chart, open a Github [issue](https://github.com/truecharts/apps/issues/new/choose) --- All Rights Reserved - The TrueCharts Project -Footer diff --git a/cspell.config.yaml b/cspell.config.yaml index 8b07b0e9211..62761e3ba44 100644 --- a/cspell.config.yaml +++ b/cspell.config.yaml @@ -1,45 +1,24 @@ version: "0.2" -# ignorepaths: [] -# dictionarydefinitions: [] -# dictionaries: [] -# ignorewords: [] -# import: [] words: - aliasgroup - - collabora - - configmap - - daemonset - - duplicati - - dynmap - - healthcheck - - kubernetes - - lancache - - loolwsd - - meshroom - - minecraft - - modelstore - - modports - - nextcloud - - notebookbar - - puid - - rcon - - serviceexpert - - ssvnc - - statefulset - - subquestions - - tccr - - traefik - - truecharts - allowtransparency + - APITOKEN - appname - backupname - bazarr - bugfixer's - cheatsheet + - Cloudflareddns + - collabora + - configmap + - daemonset - dockerized + - duplicati + - dynmap - eptgmk - gibibyte - gluster + - healthcheck - healthchecks - hostpath - hyperconverged @@ -47,6 +26,7 @@ words: - iban - ipaddr - ixcert + - ixsystems - jackett - jacobalberty - jailman @@ -55,18 +35,26 @@ words: - kube - kubeconfig - kubectl + - kubernetes + - lancache - lebbing - letsencrypt - lidarr - loadbalancer + - loolwsd + - meshroom - metallb - milicpu - minecraft - minio + - modelstore + - modports - mountpoint + - nextcloud - nobind - nodeport - nodeports + - notebookbar - ornias - ovpn - pgid @@ -75,31 +63,40 @@ words: - plex - preconfigured - proto + - puid - pvcname - pvcpath - quotum - radarr - ramdisk + - rcon + - RECORDTYPES - reneg - resolv - sabnzbd - schouten - selfsigned + - serviceexpert - smallblock - sonarr - sonarrsabnzbd + - ssvnc + - statefulset - subchart - sublist - subquestion + - subquestions - svcname - syncthing - targetport + - tccr + - traefik + - truecharts - truenas - truetool - unifi - valheim - vaultwarden - - ixsystems - vdev - vm's - websecure