Skip to content

Commit

Permalink
Fix review comments (#7)
Browse files Browse the repository at this point in the history
* Fix baseurl in the production env

Because reviewers get confused when the breadcrumb links point to the main site

* Don't use runtime scans in plural in titles

Nor at other places where its not needed

* Mention why AWS prerequisites are needed
  • Loading branch information
fekete-robert authored Oct 16, 2023
1 parent 7825fa3 commit 5b64ed8
Show file tree
Hide file tree
Showing 5 changed files with 9 additions and 9 deletions.
4 changes: 2 additions & 2 deletions config/production/config.toml
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
baseurl = "https://openclarity.io/"
baseurl = "https://docs.openclarity.io/"
buildDrafts = false
#googleAnalytics = "G-FIXME"

Expand All @@ -9,4 +9,4 @@ buildDrafts = false

[params]

url_latest_version = "https://openclarity.io/"
url_latest_version = "https://docs.openclarity.io/"
8 changes: 4 additions & 4 deletions content/docs/kubeclarity/concepts/runtime-scans/_index.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: Kubernetes clusters runtime scans
title: Kubernetes cluster runtime scan
weight: 200
linktitle: Runtime scans
linktitle: Runtime scan
---

{{< include-headless "kubeclarity/intro-runtime-scans.md" >}}
Expand All @@ -10,7 +10,7 @@ linktitle: Runtime scans

KubeClarity enhance the runtime scanning experience:

### Faster runtime scans
### Faster runtime scan

KubeClarity optimizes the scanning process, reducing the time required to detect vulnerabilities. This allows for quicker identification and remediation of potential security risks.

Expand All @@ -28,6 +28,6 @@ The following figure illustrates the structure of a runtime scanning architectur

![KubeClarity Runtime Scan Architecture](runtime-scan-architecture.png)

## Perform runtime scans
## Perform runtime scan

For details on performing runtime scans with KubeClarity, see the {{% xref "/docs/kubeclarity/getting-started/_index.md" %}} and {{% xref "/docs/kubeclarity/runtime-scans/_index.md" %}}.
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ KubeClarity requires these Kubernetes permissions:

### Prerequisites for AWS

If you are installing KubeClarity on AWS, complete the following steps:
If you are installing KubeClarity on AWS, complete the following steps. These are needed because KubeClarity uses a persistent PostgreSQL database, and that requires a volume.

1. Make sure that your EKS cluster is 1.23 or higher.
1. Install the **EBS CSI Driver** EKS add-on. For details, see [Amazon EKS add-ons](https://docs.aws.amazon.com/eks/latest/userguide/eks-add-ons.html).
Expand Down
2 changes: 1 addition & 1 deletion content/docs/kubeclarity/private-registry/cli/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ linktitle: CLI
weight: 100
---

The KubeClarity CLI can read a configuration file that stores credentials for private registries.
The KubeClarity CLI can read a configuration file that stores credentials for private registries. (For details, on using an external configuration file, see {{% xref "/docs/kubeclarity/external-config-file-cli/_index.md" %}}).

Example registry section of the configuration file:

Expand Down
2 changes: 1 addition & 1 deletion content/docs/kubeclarity/runtime-scans/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,4 +5,4 @@ weight: 800

{{< include-headless "kubeclarity/intro-runtime-scans.md" >}}

For details on the concepts of KubeClarity runtime scans, see {{% xref "/docs/kubeclarity/concepts/runtime-scans/_index.md" %}}.
For details on the concepts of KubeClarity runtime scan, see {{% xref "/docs/kubeclarity/concepts/runtime-scans/_index.md" %}}.

0 comments on commit 5b64ed8

Please sign in to comment.