Fixing markdown formatting warns and errors.

smithy-security · Sep 5, 2024 · f5c7463 · f5c7463
1 parent ba8c117
commit f5c7463
Show file tree

Hide file tree

Showing 5 changed files with 35 additions and 23 deletions.
diff --git a/README.md b/README.md
@@ -67,8 +67,8 @@ flowchart LR
 
 ## Getting Started
 
-The [Getting Started](docs/getting-started.md) tutorial explains how to get started
-with Dracon.
+The [Getting Started](docs/getting-started.md) tutorial explains
+how to get started with Dracon.
 You can also access our community contributed pipelines
 [here](https://github.com/ocurity/dracon-community-pipelines).
 

diff --git a/components/producers/github-code-scanning/README.md b/components/producers/github-code-scanning/README.md
@@ -1,5 +1,7 @@
 # Producer: GitHub Code Scanning
 
+<!--lint disable maximum-line-length-->
+
 This producer [queries the GitHub Code Scanning API](https://docs.github.com/en/rest/code-scanning/code-scanning?apiVersion=2022-11-28#list-code-scanning-alerts-for-a-repository) to produce SAST findings.
 
 ## Parameters
@@ -11,3 +13,5 @@ All parameters are **required**.
 | `producer-github-code-scanning-repository-owner` | `string` | N/A     | The owner of the repository to scan.                                                                                                                                                                                                                     |
 | `producer-github-code-scanning-repository-name`  | `string` | N/A     | The name of the repository to scan.                                                                                                                                                                                                                      |
 | `producer-github-code-scanning-github-token`     | `string` | N/A     | The GitHub token to use for scanning. Must have "Code scanning alerts" repository permissions (read) ([More Information](https://docs.github.com/en/rest/code-scanning/code-scanning?apiVersion=2022-11-28#list-code-scanning-alerts-for-a-repository)). |
+
+<!--lint enable maximum-line-length-->
diff --git a/components/producers/semgrep/README.md b/components/producers/semgrep/README.md
@@ -1,5 +1,7 @@
 # Producer: Semgrep
 
+<!--lint disable maximum-line-length-->
+
 This producer runs [the Semgrep CLI](https://semgrep.dev/docs/cli-reference) to produce SAST findings.
 
 ## Parameters
@@ -10,3 +12,5 @@ All parameters are optional. The producer works with the default configuration a
 | ------------------------------- | -------- | ------------- | -------------------------------------------------------------------------------------- |
 | `producer-semgrep-config-value` | `string` | `"auto"`      | The config for the Semgrep producer. Passed directly to the CLI via `--config`         |
 | `producer-semgrep-rules-yaml`   | `string` | `"rules: []"` | Additional rules passed to Semgrep https://semgrep.dev/docs/writing-rules/rule-syntax. |
+
+<!--lint enable maximum-line-length-->
diff --git a/components/producers/typescript-eslint/examples/README.md b/components/producers/typescript-eslint/examples/README.md
@@ -2,8 +2,12 @@
 
 ## dvna.json
 
+<!--lint disable maximum-line-length-->
+
 Using eslint with [eslint-plugin-security](https://www.npmjs.com/package/eslint-plugin-security) to generate the report.
 
+<!--lint enable maximum-line-length-->
+
 ```bash
 go run ../main.go -in ./dvna.json -out ./dvna.pb
 ```
diff --git a/docs/getting-started.md b/docs/getting-started.md
@@ -3,8 +3,8 @@
 This guide will help to quickly setup Dracon on a Kubernetes cluster and get a
 pipeline running. The first step is to create a dev Kubernetes cluster in order
 to deploy Tekton. We suggest you use KiND to provision a local test cluster
-quickly. If you already have a Kubernetes cluster then, you can skip directly to the
-[Deploying Dracon dependencies](#deploying-dracon-dependencies) section.
+quickly. If you already have a Kubernetes cluster then, you can skip directly
+to the [Deploying Dracon dependencies](#deploying-dracon-dependencies) section.
 
 We support two ways of deploying Dracon.
 
@@ -102,32 +102,32 @@ and MongoDB. The values used are in the `deploy/dracon/values/dev.yaml` file.
 
 1. Expose the TektonCD Dashboard
 
-    ```bash
-    kubectl -n tekton-pipelines port-forward svc/tekton-dashboard 9097:9097
-    ```
+```bash
+kubectl -n tekton-pipelines port-forward svc/tekton-dashboard 9097:9097
+```
 
 2. Expose the Kibana Dashboard.
 
-   ```bash
-    # Use `kubectl port-forward ...` to access the Kibana UI:
-    kubectl -n dracon port-forward svc/dracon-kb-kibana-kb-http 5601:5601
-    # You can obtain the password by examining the 
-    # `dracon-es-elasticsearch-es-elastic-user` secret:
-    # The username is `elastic`.
-    kubectl -n dracon get secret dracon-es-elasticsearch-es-elastic-user \
-      -o=jsonpath='{.data.elastic}' | \
-      base64 -d && \
-      echo
-   ```
+```bash
+# Use `kubectl port-forward ...` to access the Kibana UI:
+kubectl -n dracon port-forward svc/dracon-kb-kibana-kb-http 5601:5601
+# You can obtain the password by examining the 
+# `dracon-es-elasticsearch-es-elastic-user` secret:
+# The username is `elastic`.
+kubectl -n dracon get secret dracon-es-elasticsearch-es-elastic-user \
+  -o=jsonpath='{.data.elastic}' | \
+  base64 -d && \
+  echo
+```
 
 3. Expose the Kibana Dashboard
 
-    ```bash
-    # Use `kubectl port-forward ...` to access the Kibana UI:
-    kubectl -n dracon port-forward svc/dracon-kb-kibana-kb-http 5601:5601
-    ```
+```bash
+ # Use `kubectl port-forward ...` to access the Kibana UI:
+ kubectl -n dracon port-forward svc/dracon-kb-kibana-kb-http 5601:5601
+```
 
-   The username/password is the same as Kibana
+The username/password is the same as Kibana
 
 ### Deploy Dracon components