Add troubleshooting section in documentation (#414)

* Add troubleshooting section in documentation Related to #374 * build
nvuillam · Aug 25, 2024 · f587d42 · f587d42
1 parent 876aa5e
commit f587d42
Show file tree

Hide file tree

Showing 3 changed files with 27 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -427,6 +427,19 @@ Example
     console.log(JSON.stringify(linter.lintResult));
 ```
 
+## Troubleshooting
+
+If you have issues with MegaLinter, you can [report it on the repository](https://github.com/nvuillam/npm-groovy-lint/issues)
+
+To help reproducing, you can access advanced logs using DEBUG env variables
+
+Examples:
+
+- `DEBUG=npm-groovy-lint npm-groovy-lint ....`
+- `DEBUG=npm-groovy-lint,npm-groovy-lint-trace npm-groovy-lint ....`
+
+If you want to see what happens in CodeNarc Server, you can clone the repo and run locally `npm server:run` before running npm-groovy-lint: you'll see the live logs of the to CodeNarc Server for npm-groovy-lint.
+
 ## Contribute
 
 Contributions are very welcome !

diff --git a/docs/index.md b/docs/index.md
@@ -427,6 +427,19 @@ Example
     console.log(JSON.stringify(linter.lintResult));
 ```
 
+## Troubleshooting
+
+If you have issues with MegaLinter, you can [report it on the repository](https://github.com/nvuillam/npm-groovy-lint/issues)
+
+To help reproducing, you can access advanced logs using DEBUG env variables
+
+Examples:
+
+- `DEBUG=npm-groovy-lint npm-groovy-lint ....`
+- `DEBUG=npm-groovy-lint,npm-groovy-lint-trace npm-groovy-lint ....`
+
+If you want to see what happens in CodeNarc Server, you can clone the repo and run locally `npm server:run` before running npm-groovy-lint: you'll see the live logs of the to CodeNarc Server for npm-groovy-lint.
+
 ## Contribute
 
 Contributions are very welcome !

diff --git a/mkdocs.yml b/mkdocs.yml
@@ -45,6 +45,7 @@ nav:
   - "Auto-fixable rules": "./#auto-fixable-rules"
   - "CI/CD": "./#cdci"
   - "Use as module": "./#use-as-module"
+  - "Troubleshooting": "./#troubleshooting"
   - "Contribute": "./#contribute"
   - "Thanks": "./#thanks"
   - "Changelog": "CHANGELOG.md"