Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix(docs): fix capitalization and docs template #6947

Merged
merged 6 commits into from
Mar 20, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions docs/kics_auto_remediation.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# KICS AUTO REMEDIATION
# KICS Auto Remediation

With this new feature, KICS provides auto remediation for simple replacements and simple additions in a single line.

Expand All @@ -10,7 +10,7 @@ Note that this feature will be only available for Terraform, for now.



## HOW KICS AR WORKS?
## How KICS AR works?


1. As a first step, you will need to scan your project/file and generate a JSON report.
Expand Down
2 changes: 2 additions & 0 deletions docs/performance.md
Original file line number Diff line number Diff line change
Expand Up @@ -68,7 +68,9 @@ Flag: `--profiling CPU`
9:43AM INF Inspector stopped
9:43AM INF Scan duration: 21.1476197s
```

---

### MEM Profiling

Flag: `--profiling MEM`
Expand Down
6 changes: 3 additions & 3 deletions docs/utilities.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# UTILITIES
# Utilities


## LINES SCANNED AND LINES PARSED
## Lines scanned and lines parsed

KICS presents the number of lines scanned and the number of lines parsed. Both are presented in LOG messages and the JSON report. Note that the number of the lines includes empty ones.

Expand All @@ -19,7 +19,7 @@ Lines scanned are the lines of the files that were scanned, in the first instanc



## RESOURCE TYPE AND RESOURCE NAME
## Resource type and resource name

KICS presents the resource type and the resource name fields in the JSON result of each query. These fields are available for the following platforms: Ansible, Azure Resource Manager, CloudFormation, CrossPlane, Knative, Kubernetes, Google Deployment Manager, Pulumi, ServerlessFW and Terraform.

Expand Down
Loading