improve docs (#511)

This commit is contained in:
AlteredCoder 2020-12-04 14:24:34 +01:00 committed by GitHub
parent a9353e3016
commit cbbe210736
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
2 changed files with 11 additions and 11 deletions

View file

@ -2,16 +2,16 @@
## What is {{v1X.crowdsec.name}} ?
{{v1X.crowdsec.Name}} is a security open-source software. See the [overview](/#what-is-crowdsec)
{{v1X.crowdsec.Name}} is a security open-source software. See the [overview](/#what-is-crowdsec).
## What language is it written in ?
{{v1X.crowdsec.Name}} is written in [Golang](https://golang.org/)
{{v1X.crowdsec.Name}} is written in [Golang](https://golang.org/).
## What licence is {{v1X.crowdsec.name}} released under ?
{{v1X.crowdsec.Name}} is under [MIT license]({{v1X.crowdsec.url}}/blob/master/LICENSE)
{{v1X.crowdsec.Name}} is under [MIT license]({{v1X.crowdsec.url}}/blob/master/LICENSE).
## Which information is sent to the APIs ?
@ -73,7 +73,7 @@ Defaults env_keep += "HTTP_PROXY HTTPS_PROXY NO_PROXY"
## How to report a bug ?
To report a bug, please open an issue on the [repository]({{v1X.crowdsec.bugreport}})
To report a bug, please open an issue on the [repository]({{v1X.crowdsec.bugreport}}).
## What about false positives ?

View file

@ -1,13 +1,15 @@
site_name: Crowdsec
nav:
- Home: index.md
- Crowdsec v0: '!include ./docs/v0.3.X/mkdocs.yml'
- Crowdsec v1 : '!include ./docs/v1.X/mkdocs.yml'
- Crowdsec v0: "!include ./docs/v0.3.X/mkdocs.yml"
- Crowdsec v1 : "!include ./docs/v1.X/mkdocs.yml"
- Developers : https://crowdsecurity.github.io/api_doc/index.html?urls.primaryName=LAPI" target="_blank
- Hub : https://hub.crowdsec.net/" target="_blank
- Releases : https://github.com/crowdsecurity/crowdsec/releases" target="_blank
- Contributing: contributing.md
- FAQ: faq.md
- Contributing:
- Guide: contributing.md
- FAQ:
- Questions: faq.md
markdown_extensions:
@ -24,6 +26,7 @@ theme:
- navigation.tabs
- navigation.expand
- navigation.instant
- navigation.section
palette:
primary: "#3d85c6"
language: en
@ -38,9 +41,6 @@ plugins:
- search
- macros
- monorepo
google_analytics:
- UA-164365852-3
- auto
extra:
swagger_url: "https://raw.githubusercontent.com/crowdsecurity/crowdsec/master/pkg/models/localapi_swagger.yaml"