Update doc & explanations about license (#2766)

* [automation] Auto-update linters version, help and documentation * Add license explanations * cloudity * cspell * trivy * special thanks * [automation] Auto-update linters version, help and documentation * borja * [MegaLinter] Apply linters fixes * [MegaLinter] Apply linters fixes * Build * Disable vale to improve perfs --------- Co-authored-by: nvuillam <[email protected]>
oxsecurity · Jul 3, 2023 · 0e24913 · 0e24913
1 parent adef76f
commit 0e24913
Show file tree

Hide file tree

Showing 13 changed files with 68 additions and 7 deletions.
diff --git a/.cspell.json b/.cspell.json
@@ -184,6 +184,7 @@
         "BUILTINS",
         "Bame",
         "Berkers",
+        "Borja",
         "Bosse",
         "Braintree",
         "Bubley",
@@ -212,6 +213,7 @@
         "Citet",
         "Classpath",
         "Cleveref",
+        "Cloudity",
         "Codespaces",
         "Concat",
         "Conda",

diff --git a/.mega-linter.yml b/.mega-linter.yml
@@ -18,6 +18,7 @@ DISABLE_LINTERS:
   - REPOSITORY_KICS
   - SPELL_PROSELINT
   - SPELL_MISSPELL
+  - SPELL_VALE
 DISABLE_ERRORS_LINTERS:
   - PYTHON_BANDIT
   - PYTHON_PYRIGHT

diff --git a/README.md b/README.md
@@ -1592,6 +1592,15 @@ description: List of all contributors, websites and linters that help MegaLinter
 -->
 ## Special thanks
 
+### Maintainers
+
+MegaLinter wouldn't be what it is without its great team of maintainers !
+
+- [Kurt Von Laven](https://github.com/Kurt-von-Laven)
+- [Borja Dominguez](https://github.com/bdovaz)
+- [Edouard Choiniere](https://github.com/echoix)
+- [Nicolas Vuillamy](https://github.com/nvuillam) (Creator)
+
 ### Contributors
 
 <a href="https://github.com/oxsecurity/megalinter/graphs/contributors">

diff --git a/docs/descriptors/powershell_powershell.md b/docs/descriptors/powershell_powershell.md
@@ -39,7 +39,7 @@ description: How to use powershell (configure, ignore files, ignore errors, help
 | POWERSHELL_POWERSHELL_RULES_PATH                  | Path where to find linter configuration file                                                                                                                                                 | Workspace folder, then MegaLinter default rules                     |
 | POWERSHELL_POWERSHELL_DISABLE_ERRORS              | Run linter but consider errors as warnings                                                                                                                                                   | `false`                                                             |
 | POWERSHELL_POWERSHELL_DISABLE_ERRORS_IF_LESS_THAN | Maximum number of errors allowed                                                                                                                                                             | `0`                                                                 |
-| POWERSHELL_POWERSHELL_CLI_EXECUTABLE              | Override CLI executable                                                                                                                                                                      | `['pwsh']`                                                          |
+| POWERSHELL_POWERSHELL_CLI_EXECUTABLE              | Override CLI executable                                                                                                                                                                      | `['powershell']`                                                    |
 
 ## IDE Integration
 

diff --git a/docs/descriptors/powershell_powershell_formatter.md b/docs/descriptors/powershell_powershell_formatter.md
@@ -40,7 +40,7 @@ description: How to use powershell_formatter (configure, ignore files, ignore er
 | POWERSHELL_POWERSHELL_FORMATTER_RULES_PATH                  | Path where to find linter configuration file                                                                                                                                                 | Workspace folder, then MegaLinter default rules                     |
 | POWERSHELL_POWERSHELL_FORMATTER_DISABLE_ERRORS              | Run linter but consider errors as warnings                                                                                                                                                   | `true`                                                              |
 | POWERSHELL_POWERSHELL_FORMATTER_DISABLE_ERRORS_IF_LESS_THAN | Maximum number of errors allowed                                                                                                                                                             | `0`                                                                 |
-| POWERSHELL_POWERSHELL_FORMATTER_CLI_EXECUTABLE              | Override CLI executable                                                                                                                                                                      | `['pwsh']`                                                          |
+| POWERSHELL_POWERSHELL_FORMATTER_CLI_EXECUTABLE              | Override CLI executable                                                                                                                                                                      | `['powershell']`                                                    |
 
 ## IDE Integration
 

diff --git a/docs/descriptors/python_mypy.md b/docs/descriptors/python_mypy.md
@@ -382,5 +382,10 @@ Environment variables:
 
 ### Installation on mega-linter Docker image
 
+- Dockerfile commands :
+```dockerfile
+ENV MYPY_CACHE_DIR=/tmp
+```
+
 - PIP packages (Python):
   - [mypy](https://pypi.org/project/mypy)
diff --git a/docs/descriptors/repository_devskim.md b/docs/descriptors/repository_devskim.md
@@ -9,6 +9,9 @@ description: How to use devskim (configure, ignore files, ignore errors, help &
 
 Use `--ignore-globs` to ignore files and/or folders
 
+Example:
+  `REPOSITORY_DEVSKIM_ARGUMENTS: ['--ignore-globs','**/megalinter-reports/**,**/.git/**,**/bin/**']`
+
 ## devskim documentation
 
 - Version in MegaLinter: **1.0.11**

diff --git a/docs/descriptors/xml_xmllint.md b/docs/descriptors/xml_xmllint.md
@@ -25,7 +25,7 @@ To apply file formatting you must set `XML_XMLLINT_CLI_LINT_MODE: file` and `XML
 | Variable                                | Description                                                                                                                                                                                                         | Default value      |
 |-----------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------|
 | XML_XMLLINT_AUTOFORMAT                  | If set to `true`, it will reformat and reindent the output                                                                                                                                                          | `false`            |
-| XML_XMLLINT_INDENT                      | The number of indentation spaces when `XML_XMLLINT_AUTOFORMAT` is `true`                                                                                                                                            | ``                 |
+| XML_XMLLINT_INDENT                      | The number of indentation spaces when `XML_XMLLINT_AUTOFORMAT` is `true`                                                                                                                                            | `  `               |
 | XML_XMLLINT_ARGUMENTS                   | User custom arguments to add in linter CLI call<br/>Ex: `-s --foo "bar"`                                                                                                                                            |                    |
 | XML_XMLLINT_FILTER_REGEX_INCLUDE        | Custom regex including filter<br/>Ex: `(src\|lib)`                                                                                                                                                                  | Include every file |
 | XML_XMLLINT_FILTER_REGEX_EXCLUDE        | Custom regex excluding filter<br/>Ex: `(test\|examples)`                                                                                                                                                            | Exclude no file    |

diff --git a/docs/license-explanations.md b/docs/license-explanations.md
@@ -0,0 +1,30 @@
+---
+title: License explanation
+description: What you can do and can not do with MegaLinter
+---
+<!-- markdownlint-disable MD013 -->
+
+# Why AGPL V3 License ?
+
+MegaLinter is an open-source and free tool graciously provided to the developer community.
+
+We don't earn money with MegaLinter, but it takes a lot of time to maintain it, so we want to avoid companies to make money with it by selling software or services without sharing their sources, like it happened in the past with [ElasticSearch](https://www.elastic.co/blog/why-license-change-aws) or [MongoDB](https://techcrunch.com/2018/10/16/mongodb-switches-up-its-open-source-license/).
+
+## What you can do
+
+- Use MegaLinter in public repositories
+- Use MegaLinter in private repositories, even commercial ones
+- Use MegaLinter to build commercial closed-source applications
+- Use MegaLinter on on-premise Git services, like Github Enterprise or Gitlab Community Edition
+- Sell professional services to setup and maintain MegaLinter in the repositories of your clients
+
+## What you can not do
+
+- Sell MegaLinter
+- Expose a closed-source online service that calls MegaLinter in the background
+
+## What you could do
+
+If you have a professional use of MegaLinter, you can be nice and support us by [sponsoring us](https://megalinter.io/latest/sponsor/), and ask your clients to sponsor us too :)
+
+Any questions ? [Contact us](https://www.ox.security/contact/) !
diff --git a/docs/special-thanks.md b/docs/special-thanks.md
@@ -8,6 +8,15 @@ description: List of all contributors, websites and linters that help MegaLinter
 
 # Special thanks
 
+## Maintainers
+
+MegaLinter wouldn't be what it is without its great team of maintainers !
+
+- [Kurt Von Laven](https://github.com/Kurt-von-Laven)
+- [Borja Dominguez](https://github.com/bdovaz)
+- [Edouard Choiniere](https://github.com/echoix)
+- [Nicolas Vuillamy](https://github.com/nvuillam) (Creator)
+
 ## Contributors
 
 <a href="https://github.com/oxsecurity/megalinter/graphs/contributors">

diff --git a/docs/sponsor.md b/docs/sponsor.md
@@ -4,7 +4,7 @@ description: Help MegaLinter open-source by sponsoring it
 ---
 # Sponsoring
 
-I maintain MegaLinter as a hobby, but when I'm not working on my [job as Hardis Group SFDC CTO](https://www.linkedin.com/in/nicolas-vuillamy/), I also have other hobbys like tasting good beers :)
+I maintain MegaLinter as a hobby, but when I'm not working on my [job as CTO at Cloudity](https://www.linkedin.com/in/nicolas-vuillamy/), I also have other hobbys like tasting good beers :)
 
 So if you like MegaLinter and want to support me with one or several beers a month, please have a look a my [Github Sponsoring Page](https://github.com/sponsors/nvuillam)
 

diff --git a/megalinter/descriptors/schemas/megalinter-configuration.jsonschema.json b/megalinter/descriptors/schemas/megalinter-configuration.jsonschema.json
@@ -9845,7 +9845,7 @@
       "$id": "#/properties/POWERSHELL_POWERSHELL_CLI_EXECUTABLE",
       "default": [
         [
-          "pwsh"
+          "powershell"
         ]
       ],
       "items": {
@@ -9944,7 +9944,7 @@
       "$id": "#/properties/POWERSHELL_POWERSHELL_FORMATTER_CLI_EXECUTABLE",
       "default": [
         [
-          "pwsh"
+          "powershell"
         ]
       ],
       "items": {

diff --git a/mkdocs.yml b/mkdocs.yml
@@ -379,5 +379,7 @@ nav:
   - "Contribute":
       - "How-to Contribute": "how-to-contribute.md"
       - "Contributing Guide": "contributing.md"
-  - "License": "license.md"
+  - "License":
+      - "AGPL V3 License": "license.md"
+      - "License explanations": "license-explanations.md"
   - "Changelog": "CHANGELOG.md"