Merge branch 'main' into fharper/ci-flag

.github/workflows/check-markdown.yml

@@ -0,0 +1,20 @@
+---
+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 .md
+        uses: DavidAnson/[email protected]
+        with:
+          command: config
+          globs: |
+            .markdownlint.json
+            **.md

.markdownlint.json

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

CONTRIBUTING.md

@@ -21,7 +21,12 @@ Before making a code change, first discuss your idea via an [issue](https://gith
 
 Kubefirst is created using the [Go Programming Language](https://go.dev). To set up your computer, follow [these steps](https://go.dev/doc/install).
 
-Once Go is installed, you can run Kubefirst from any branch using `go run .`. Go will automatically install the needed modules listed in the [go.mod](go.mod) file. As an example, if you want to create a [local cluster](https://docs.kubefirst.io/kubefirst/local/install.html), the command would be `go run . local`.
+Once Go is installed, you can run Kubefirst from any branch using `go run .`. Go will automatically install the needed modules listed in the [go.mod](go.mod) file. As an example, if you want to create a [local cluster](https://docs.kubefirst.io/kubefirst/local/install.html), the command would be `go run . k3d create`. Note that even if you run kubefirst from `main`, the [gitops-template](https://github.com/kubefirst/gitops-template) version used will be the [latest release](https://github.com/kubefirst/gitops-template/releases). If you also want to use the latest from `main` for the template also, you need to run to use the `--gitops-template-url`, and the `--gitops-template-branch` as follow:
+
+```shell
+go run . k3d create --gitops-template-url https://github.com/kubefirst/gitops-template --gitops-template-branch main
+```
+
 Since Go is a compiled programming language, every time you use the `run` command, Go will compile the code before running it. If you want to save time, you can compile your code using `go build`, which will generate a file named `kubefirst`. You will then be able to run your compiled version with the `./kubefirst` command.
 
 ## Getting Started with the Documentation

README.md

@@ -1,3 +1,4 @@
+<!-- markdownlint-disable MD041 -->
 <p align="center">
   <picture>
     <source media="(prefers-color-scheme: dark)" srcset="images/kubefirst-light.svg" alt="Kubefirst Logo">
@@ -22,7 +23,6 @@
   <a href="https://github.com/kubefirst/kubefirst/releases"><img title="Release date" src="https://img.shields.io/github/release-date/kubefirst/kubefirst"/></a>
 </p>
 
-
 ---
 
 # Kubefirst CLI
@@ -46,4 +46,3 @@ Each of our platforms have install guides that detail the prerequesites, command
 Feed K-Ray a GitHub star ⭐ above to bookmark our project and keep K-Ray happy!!
 
 [![Star History Chart](https://api.star-history.com/svg?repos=kubefirst/kubefirst&type=Date)](https://star-history.com/#kubefirst/kubefirst&Date)
-

build/README.md

@@ -1,8 +1,8 @@
-# Overview 
+# Overview
 
-Kubefirst cli installation options.
+kubefirst CLI installation options.
 
-# Homebrew
+## Homebrew
 
 ```bash
 brew install kubefirst/tools/kubefirst
@@ -12,43 +12,36 @@ brew install kubefirst/tools/kubefirst
 kubefirst help
 ```
 
-# Linux Download
+## Asdf
 
-## Manual Install
+> Not maintained by kubefirst
 
-```bash
-export KUBEFIRST_VERSION=`curl https://github.com/kubefirst/kubefirst/releases/latest  -Ls -o /dev/null -w %{url_effective} | grep -oE "[^/]+$"`
-```
-
-```bash
-export BINARY_URL="https://github.com/kubefirst/kubefirst/releases/download/${KUBEFIRST_VERSION}/kubefirst_${KUBEFIRST_VERSION:1}_linux_amd64.tar.gz"
-```
-
-```bash
-curl -LO $BINARY_URL && \
-  tar -xvf kubefirst_${KUBEFIRST_VERSION:1}_linux_amd64.tar.gz -C /usr/local/bin/ && \
-  chmod +x /usr/local/bin/kubefirst
-```
-
-```bash
-kubefirst info
-```
-
-## Install with ASDF ([asdf-kubefirst](https://github.com/Claywd/asdf-kubefirst)) 
-  *Not maintained by kubefirst*
-
 It's best to run latest but if you already have asdf setup and prefer to use it, there is a kubefirst plugin available to get kubefirst installed and running quickly with asdf.
 
 Installation instructions for asdf are here. Confirm its installed with `asdf version`
     The [asdf-kubefirst plugin is here](https://github.com/Claywd/asdf-kubefirst)
 
 Once you have asdf installed, just run the following commands kubefirst will be up and running.
 
-```zsh
-asdf plugin-add kubefirst https://github.com/Claywd/asdf-kubefirst.git;
-asdf install kubefirst latest;
-asdf global kubefirst;
-kubefirst version; 
+```shell
+asdf plugin-add kubefirst https://github.com/Claywd/asdf-kubefirst.git
+asdf install kubefirst latest
+asdf global kubefirst
+kubefirst version
 ```
 
+## Linux Manual Installation
 
+```shell
+export KUBEFIRST_VERSION=`curl https://github.com/kubefirst/kubefirst/releases/latest  -Ls -o /dev/null -w %{url_effective} | grep -oE "[^/]+$"`
+```
+
+```shell
+export BINARY_URL="https://github.com/kubefirst/kubefirst/releases/download/${KUBEFIRST_VERSION}/kubefirst_${KUBEFIRST_VERSION:1}_linux_amd64.tar.gz"
+```
+
+```shell
+curl -LO $BINARY_URL && \
+  tar -xvf kubefirst_${KUBEFIRST_VERSION:1}_linux_amd64.tar.gz -C /usr/local/bin/ && \
+  chmod +x /usr/local/bin/kubefirst
+```