From 18351e68d6b42fd491e6414aabfe3c22847ac764 Mon Sep 17 00:00:00 2001 From: Artur Ribeiro Date: Mon, 11 Mar 2024 18:25:20 +0000 Subject: [PATCH 1/3] fix(docs): fix capitalization and docs --- docs/kics_auto_remediation.md | 4 ++-- docs/utilities.md | 6 +++--- 2 files changed, 5 insertions(+), 5 deletions(-) diff --git a/docs/kics_auto_remediation.md b/docs/kics_auto_remediation.md index 8dffbed75e9..e3c005b8e4a 100644 --- a/docs/kics_auto_remediation.md +++ b/docs/kics_auto_remediation.md @@ -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. @@ -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. diff --git a/docs/utilities.md b/docs/utilities.md index 10d0ce251e5..4cc7f09e32b 100644 --- a/docs/utilities.md +++ b/docs/utilities.md @@ -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. @@ -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. From 0bd6aa5a04f8e9333a58435131927c7b720b552d Mon Sep 17 00:00:00 2001 From: JulioSCX Date: Mon, 11 Mar 2024 18:26:48 +0000 Subject: [PATCH 2/3] fixed error in profiling page --- docs/performance.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/docs/performance.md b/docs/performance.md index 3d248ef614e..0c0bd076d57 100644 --- a/docs/performance.md +++ b/docs/performance.md @@ -68,7 +68,9 @@ Flag: `--profiling CPU` 9:43AM INF Inspector stopped 9:43AM INF Scan duration: 21.1476197s ``` + --- + ### MEM Profiling Flag: `--profiling MEM` From 04727b2060256cce7d73044e82f035d87de0751e Mon Sep 17 00:00:00 2001 From: Gabriel Date: Wed, 13 Mar 2024 15:39:49 +0000 Subject: [PATCH 3/3] Update docs/kics_auto_remediation.md --- docs/kics_auto_remediation.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/kics_auto_remediation.md b/docs/kics_auto_remediation.md index e3c005b8e4a..0338c1133bc 100644 --- a/docs/kics_auto_remediation.md +++ b/docs/kics_auto_remediation.md @@ -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.