From aab22f29875eae367a9fad7cc0eac9dbd5a84795 Mon Sep 17 00:00:00 2001 From: Andy Waite Date: Thu, 18 Jun 2020 11:38:27 -0400 Subject: [PATCH 1/3] Fix RuboCop capitalization in README --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index a55132e7..b0b8f71e 100644 --- a/README.md +++ b/README.md @@ -18,7 +18,7 @@ Developers on **GitHub** can call the **GitHub Action** to lint their code base | *Language* | *Linter* | |---|---| -| **Ruby** | Rubocop | +| **Ruby** | RuboCop | | **Shell** | Shellcheck | | **Ansible** | Ansible-lint | | **YAML** | Yamllint | From 2a8a75304c78a261e6a1bb17adb99fddb0894afa Mon Sep 17 00:00:00 2001 From: Misha Brukman Date: Thu, 18 Jun 2020 11:57:58 -0400 Subject: [PATCH 2/3] Fix capitalization [skip ci] * Markdown [1,2] has no capital 'd' * CoffeeScript [3,4], JavaScript [5,6], TypeScript [7,8,9] all capitalize 'S' * GitHub [10,11] capitalizes the 'H' References: [1] https://en.wikipedia.org/wiki/Markdown [2] https://daringfireball.net/projects/markdown/syntax [3] https://en.wikipedia.org/wiki/CoffeeScript [4] https://coffeescript.org/ [5] https://en.wikipedia.org/wiki/JavaScript [6] https://developer.mozilla.org/en-US/docs/Web/JavaScript [7] https://en.wikipedia.org/wiki/TypeScript [8] https://www.typescriptlang.org/ [9] https://github.com/Microsoft/TypeScript [10] https://en.wikipedia.org/wiki/GitHub [11] https://github.com/about --- README.md | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index a55132e7..e898e68f 100644 --- a/README.md +++ b/README.md @@ -24,12 +24,12 @@ Developers on **GitHub** can call the **GitHub Action** to lint their code base | **YAML** | Yamllint | | **Python3** | Pylint | | **JSON** | JsonLint | -| **MarkDown** | Markdownlint | +| **Markdown** | Markdownlint | | **Perl** | Perl | | **XML** | LibXML | -| **Coffeescript** | coffeelint | -| **Javascript** | eslint standard | -| **Typescript** | eslint standard | +| **CoffeeScript** | coffeelint | +| **JavaScript** | eslint standard | +| **TypeScript** | eslint standard | | **Golang** | golangci-lint | | **Dockerfile** | dockerfilelint | | **Terraform** | tflint | @@ -157,9 +157,9 @@ The **Super-Linter** has *CI/CT/CD* configured utilizing **GitHub** Actions. - **Note:** The branches **Docker** container is also removed from **DockerHub** to cleanup after itself ## Limitations -Below are a list of the known limitations for the **Github Super-Linter**: +Below are a list of the known limitations for the **GitHub Super-Linter**: - Due to being completely packaged at run time, you will not be able to update dependencies or change versions of the enclosed linters and binaries -- Reading additional details from `package.json` are not read by the **Github Super-Linter** +- Reading additional details from `package.json` are not read by the **GitHub Super-Linter** - Downloading additional codebases as dependencies from private repositories will fail due to lack of permissions ## How to contribute From c1f8e7c7995d22bbb73c444d24744fd58f12330b Mon Sep 17 00:00:00 2001 From: Yves Brissaud Date: Thu, 18 Jun 2020 18:03:50 +0200 Subject: [PATCH 3/3] Use public URL for the Docker container The previous one in the README is the URL to manage the repository (when you are the owner). --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index a55132e7..41c2d32a 100644 --- a/README.md +++ b/README.md @@ -142,7 +142,7 @@ You can use the **GitHub** **Super-Linter** *with* or *without* your own persona If you need to disable certain *rules* and *functionality*, you can view [Disable Rules](https://github.com/github/super-linter/blob/master/docs/disabling-linters.md) ## Docker Hub -The **Docker** container that is built from this repository is located at `https://cloud.docker.com/u/admiralawkbar/repository/docker/admiralawkbar/super-linter` +The **Docker** container that is built from this repository is located at `https://hub.docker.com/r/admiralawkbar/super-linter` ## Running Super-Linter locally (troubleshooting/debugging/enhancements) If you find that you need to run super-linter locally, you can follow the documentation at [Running super-linter locally](https://github.com/github/super-linter/blob/master/docs/run-linter-locally.md)