Skip to content

Commit

Permalink
ci: add a workflow to validate Markdown syntax
Browse files Browse the repository at this point in the history
Also fixed some Markdown issues
  • Loading branch information
fharper committed Sep 19, 2023
1 parent 7e2a149 commit cf37da2
Show file tree
Hide file tree
Showing 4 changed files with 57 additions and 33 deletions.
20 changes: 20 additions & 0 deletions .github/workflows/check-markdown.yml
Original file line number Diff line number Diff line change
@@ -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
12 changes: 12 additions & 0 deletions .markdownlint.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
{
"MD013": false,
"MD024": false,
"MD025": false,
"MD033": false,
"MD049": {
"style": "underscore"
},
"MD050": {
"style": "asterisk"
}
}
3 changes: 1 addition & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -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">
Expand All @@ -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
Expand All @@ -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)

55 changes: 24 additions & 31 deletions build/README.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
# Overview
# Overview

Kubefirst cli installation options.
kubefirst CLI installation options.

# Homebrew
## Homebrew

```bash
brew install kubefirst/tools/kubefirst
Expand All @@ -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
```

0 comments on commit cf37da2

Please sign in to comment.