feat: adding issue template for documentation (#4453)

This commit is contained in:
Anais Urlichs
2023-05-30 10:23:05 +01:00
committed by GitHub
parent 83a9c4a4cf
commit de6eef3b00
4 changed files with 49 additions and 2 deletions

View File

@@ -0,0 +1,28 @@
labels: ["kind/documentation"]
body:
- type: markdown
attributes:
value: |
#### Note
Feel free to create a docs report if something doesn't work as expected or is unclear in the documentation.
Please ensure that you're not creating a duplicate report by searching the [issues](https://github.com/aquasecurity/trivy/issues)/[discussions](https://github.com/aquasecurity/trivy/discussions) beforehand.
Please also check [our contribution guidelines](https://aquasecurity.github.io/trivy/latest/community/contribute/discussion/).
- type: textarea
attributes:
label: Description
description: Briefly describe the what has been unclear in the existing documentation
validations:
required: true
- type: textarea
attributes:
label: Link
description: Please provide a link to the current documentation or where you thought to find the information you were looking for
validations:
required: false
- type: textarea
attributes:
label: Suggestions
description: What would you like to have added or changed in the documentation?
validations:
required: true

View File

@@ -6,6 +6,9 @@ contact_links:
- name: Report a bug
url: https://github.com/aquasecurity/trivy/discussions/new?category=bugs
about: Report bugs
- name: Enhance documentation
url: https://github.com/aquasecurity/trivy/discussions/new?category=documentation
about: Make suggestions to the documentation
- name: Request a feature enhancement
url: https://github.com/aquasecurity/trivy/discussions/new?category=ideas
about: Share ideas for new features

View File

@@ -103,11 +103,14 @@ trivy k8s --report summary cluster
`tri` is pronounced like **tri**gger, `vy` is pronounced like en**vy**.
---
## Community
Trivy is an [Aqua Security][aquasec] open source project.
Learn about our open source work and portfolio [here][oss].
Contact us about any matter by opening a GitHub Discussion [here][discussions]
Join our [Slack community][slack] to stay up to date with community efforts.
Please ensure to abide by our [Code of Conduct][code-of-conduct] during all interactions.
[test]: https://github.com/aquasecurity/trivy/actions/workflows/test.yaml
[test-img]: https://github.com/aquasecurity/trivy/actions/workflows/test.yaml/badge.svg
@@ -122,6 +125,8 @@ Contact us about any matter by opening a GitHub Discussion [here][discussions]
[homepage]: https://trivy.dev
[docs]: https://aquasecurity.github.io/trivy
[pronunciation]: #how-to-pronounce-the-name-trivy
[slack]: https://slack.aquasec.com
[code-of-conduct]: https://github.com/aquasecurity/community/blob/main/CODE_OF_CONDUCT.md
[Installation]:https://aquasecurity.github.io/trivy/latest/getting-started/installation/
[Ecosystem]: https://aquasecurity.github.io/trivy/latest/ecosystem/

View File

@@ -4,7 +4,7 @@ site_description: A Simple and Comprehensive Vulnerability Scanner for Container
docs_dir: docs/
repo_name: GitHub
repo_url: https://github.com/aquasecurity/trivy
edit_uri: ""
edit_uri: "blob/main/docs/"
nav:
- Getting Started:
@@ -157,7 +157,11 @@ theme:
- navigation.tabs
- navigation.tabs.sticky
- navigation.sections
- navigation.footer
- content.action.edit
- content.tabs.link
- content.code.annotate
- content.code.copy
markdown_extensions:
- pymdownx.highlight
@@ -179,6 +183,13 @@ extra:
method: mike
provider: mike
default: latest
social:
- icon: fontawesome/brands/twitter
link: https://twitter.com/AquaTrivy
- icon: fontawesome/brands/github
link: https://github.com/aquasecurity/trivy
- icon: fontawesome/brands/slack
link: https://github.com/aquasecurity/trivy
plugins:
- search