Merge branch 'main' of github.com:kubefirst/gitops-catalog

.github/workflows/check-links.yml

@@ -0,0 +1,20 @@
+---
+name: Markdown Links Validation
+
+on: [push, workflow_dispatch]
+
+jobs:
+  markdown-link-check:
+    runs-on: ubuntu-latest
+    steps:
+
+      - name: Checkout this repository
+        uses: actions/[email protected]
+
+      - name: Validate Links in Markdown files
+        if: always()
+        uses: gaurav-nelson/[email protected]
+        with:
+          config-file: '.markdownlinkcheck.json'
+          use-quiet-mode: 'yes'
+          file-extension: .md

.github/workflows/check-markdown.yml

@@ -0,0 +1,18 @@
+---
+name: Markdown Syntax Validation
+
+on: [push, workflow_dispatch]
+
+jobs:
+  markdown-check:
+
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout this repository
+        uses: actions/[email protected]
+
+      - name: Validate Markdown
+        uses: DavidAnson/[email protected]
+        with:
+          config: .markdownlint.json
+          globs: "**.md"

.github/workflows/check-syntax.yml

@@ -0,0 +1,26 @@
+---
+name: Syntax Validation
+on: [push, workflow_dispatch]
+
+jobs:
+  syntax-check:
+    name: vale
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout this repository
+        uses: actions/[email protected]
+
+      - name: Get latest version of Vale
+        id: lastversion
+        uses: dvershinin/[email protected]
+        with:
+          repository: errata-ai/vale
+
+      - name: Install Vale
+        run: |
+          wget https://github.com/errata-ai/vale/releases/download/v${{ steps.lastversion.outputs.last_version }}/vale_${{ steps.lastversion.outputs.last_version }}_Linux_64-bit.tar.gz -O vale.tar.gz
+          tar -xvzf vale.tar.gz vale
+          rm vale.tar.gz
+
+      - name: Validate the syntax
+        run: ./vale --config=.vale.ini *.md

.markdownlinkcheck.json

@@ -0,0 +1,70 @@
+{
+	"ignorePatterns": [
+		{
+			"pattern": "^https://www.linkedin.com.*"
+		},
+		{
+			"pattern": ".*\\]$"
+		},
+		{
+			"pattern": "https://www.enterprisetimes.co.uk*"
+		},
+		{
+			"pattern": "https://www.pexels.com*"
+		},
+		{
+			"pattern": "https://www.pngrepo.com"
+		},
+		{
+			"pattern": "https://tdwi.org*"
+		},
+		{
+			"pattern": "https://www.fakepersongenerator.com*"
+		},
+		{
+			"pattern": "https://dash.readme.com*"
+		},
+		{
+			"pattern": "https://cfpland.com*"
+		},
+		{
+			"pattern": "https://n8n.io*"
+		},
+		{
+			"pattern": "https://confs.tech*"
+		},
+		{
+			"pattern": "https://businesswire.com*"
+		},
+		{
+			"pattern": "https://www.tmcnet.com*"
+		},
+		{
+			"pattern": "https://.*kubefirst.dev*"
+		},
+		{
+			"pattern": "http://localhost*"
+		},
+		{
+			"pattern": "https://gitlab.com*"
+		},
+		{
+			"pattern": "https://.*vultr.com*"
+		}
+	],
+	"replacementPatterns": [
+		{
+			"pattern": "{require(\"(*)\").default}",
+			"replacement": "*"
+		},
+		{
+		  "pattern": "^/img/*",
+		  "replacement": "/static/img/*"
+		}
+	],
+  "timeout": "30s",
+  "retryOn429": true,
+  "retryCount": 2,
+  "fallbackRetryDelay": "1m",
+  "aliveStatusCodes": [200, 429]
+}

.markdownlint.json

@@ -0,0 +1,12 @@
+{
+	"MD013": false,
+	"MD024": false,
+	"MD025": false,
+	"MD033": false,
+	"MD049": {
+		"style": "underscore"
+	},
+	"MD050": {
+		"style": "asterisk"
+	}
+}

.vale.ini

@@ -0,0 +1,13 @@
+StylesPath = styles
+Vocab = base
+
+[formats]
+mdx = md
+
+[*.md]
+BasedOnStyles = Custom
+Packages = alex
+IgnoredScopes = code
+BlockIgnores = (?s) *(import.*?\n), \
+               (?s) *(### gitops\n)
+TokenIgnores = (?s) *(export.*?\n)

README.md

@@ -1,3 +1,4 @@
+<!-- markdownlint-disable MD041 -->
 <p align="center">
   <picture>
     <source media="(prefers-color-scheme: dark)" srcset="img/kubefirst-light.svg" alt="Kubefirst Logo">
@@ -20,7 +21,7 @@ To make a new application available for installation, you'll need to:
   - **website**: application website or GitHub repository.
   - **imageUrl**: full web URL for the application's logo. It will be displayed in the GitOps catalog. _For now, it needs to be located on a third-party server, but we'll update this field to grab them from the GitHub repository soon, so it doesn't depend on external URL._
   - **description**: an insightful description about your application. It will be displayed in the GitOps Catalog (200 characters maximum).
-  - **categories**: one category amongts the following ones:
+  - **categories**: one category amongst the following ones:
     - App management
     - Architecture
     - CI/CD
@@ -33,7 +34,7 @@ To make a new application available for installation, you'll need to:
     - Storage
     - Testing
 - Create a new directory with your new application's name in your fork.
-  - Add, and organize your Argo CD gitops file(s) into it, if any.
+  - Add, and organize your Argo CD GitOps file(s) into it, if any.
 - Create a pull request with the changes from your branch to our main branch.
 
 ### Acceptance Criteria
@@ -46,7 +47,7 @@ We may remove an application from the GitOps Catalog with no notice if a severe
 
 ### Testing
 
-If you want to test the application you are adding to the catalog, you need to run a couple of things locally.
+If you want to test the application you are adding to the catalog, you need to run a couple of things locally. The process is a bit complicated, so feel free to submit a pull request without all the local tests, and we'll happily do the testing for you. If you want to proceed by yourself, follow these steps.
 
 Firstly, if it's not already done, you need to [create a fork](https://github.com/kubefirst/kubefirst-api/fork) of the gitops-catalog repository.
 
@@ -72,4 +73,4 @@ If you already installed the application, to reinstall it another time without r
 
 ### Need Help
 
-As always, we are on our [Slack community](https://kubefirst.io/slack) in the #gitops-catalog channel  if you need any help. We also welcome any constructive feedback or feature suggestions.
+As always, we are on our [Slack community](https://kubefirst.io/slack) in the #gitops-catalog channel if you need any help. We also welcome any constructive feedback, feature or application suggestions.

index.yaml

@@ -110,13 +110,13 @@ apps:
     categories:
       - Testing
     secretKeys:
-      - name: testkube-api.cloud.key
+      - name: API_KEY
         label: Testkube API Key
-      - name: testkube-api.cloud.orgId
+      - name: ORG_ID
         label: Testkube Org ID
-      - name: testkube-api.cloud.envId
+      - name: ENV_ID
         label: Testkube Environment ID
-        
+
   - name: tracetest
     displayName: Tracetest
     website: "https://github.com/kubeshop/tracetest"

styles/Custom/ignore.txt

@@ -0,0 +1,79 @@
+# A
+argo
+argocd
+atlantis
+aws
+
+# B
+
+# C
+chartmuseum
+civo
+cli
+config
+cronjob
+
+# D
+displayName
+
+# E
+ecr
+eks
+
+# F
+
+# G
+gcp
+github
+gitlab
+gitops
+
+# H
+https
+
+# I
+iam
+imageUrl
+
+# J
+
+# K
+kubeconfig
+kubefirst
+kubernetes
+
+# L
+
+# M
+
+# N
+
+# O
+oidc
+
+# P
+
+# Q
+
+# R
+repo
+
+# S
+
+# T
+terraform
+
+# U
+ui
+url
+
+# V
+vpc
+
+# W
+
+# X
+
+# Y
+
+# Z

styles/Custom/spelling.yml

@@ -0,0 +1,6 @@
+---
+extends: spelling
+message: "Did you really mean '%s'?"
+level: error
+ignore:
+  - styles/Custom/ignore.txt

styles/Custom/substitutions.yml

@@ -0,0 +1,56 @@
+---
+extends: substitution
+message: Consider using '%s' instead of '%s'
+ignorecase: false
+level: error
+swap:
+  # Starting or with a space before, and ending with a dot or space (so not working used in a path, caused of MDX)
+  '(?<=^| )argo [C|c][D|d](?=$| |\.)': Argo CD
+  # Starting or with a space before, and ending with a dot or space (so not working used in a path, caused of MDX)
+  '(?<=^| )Argo [C|c][D|d](?=$| |\.)': Argo CD
+  # Starting or with a space before, and ending with a dot or space (so not working used in a path, caused of MDX)
+  '(?<=^| )[A|a]rgo[C|c][D|d](?=$| |\.)': Argo CD
+  'argo [W|w]orkflows?': Argo Workflows
+  'Argo [W|w]orkflows?': Argo Workflows
+  atlantis: Atlantis
+  chartmuseum: ChartMuseum
+  cli: CLI
+  # Starting or with a space before, and ending with a dot or space (so not working used in a path, caused of MDX)
+  '(?<=^| )civo(?=$| |\.)': Civo
+  # Starting or with a space before, and ending with a dot or space (so not working used in a path, caused of MDX)
+  '(?<=^| )CIVO(?=$| |\.)': Civo
+  # Starting or with a space before, and ending with a dot or space (so not working used in a path, caused of MDX)
+  '(?<=^| )configs?(?=$| |\.)': configurations
+  cronjob: CronJob
+  ecr: ECR
+  eks: EKS
+  'digital[o|O]cean': DigitalOcean
+  '[d|D]igitalocean': DigitalOcean
+  docker: Docker
+  gcp: Google Cloud
+  gcp cloud: Google Cloud
+  # Starting or with a space before, and ending with a dot or space (so not working used in a path, caused of MDX)
+  '[G|g]ithub': GitHub
+  # Starting or with a space before, and ending with a dot or space (so not working used in a path, caused of MDX)
+  'git[H|h]ub': GitHub
+  # Starting or with a space before, and ending with a dot or space (so not working used in a path, caused of MDX)
+  '(?<=^| )[G|g]itlab(?=$| |\.)': GitLab
+  # Starting or with a space before, and ending with a dot or space (so not working used in a path, caused of MDX)
+  '(?<=^| )git[L|l]ab(?=$| |\.)': GitLab
+  # Starting or with a space before, and ending with a dot or space (so not working used in a path, caused of MDX)
+  '(?<=^| )gitops(?=$| |\.)': GitOps for the term or put gitops as inline code for the repository
+  google: Google
+  helm: Helm
+  https: HTTPS
+  iam: IAM
+  kubernetes: Kubernetes
+  mongo: MongoDB
+  oidc: OIDC
+  repo: repository
+  SSH: SSH
+  # Starting or with a space before, and ending with a dot or space (so not working used in a path, caused of MDX)
+  '(?<=^| )terraform(?=$| |\.)': Terraform
+  ui: UI
+  url: URL
+  vpc: VPC
+  vultr: Vultr