From 0387cf0292fe2877eba0b15d08a09660e69c230a Mon Sep 17 00:00:00 2001 From: Megan Wolf Date: Wed, 24 Jul 2024 14:46:32 -0400 Subject: [PATCH] docs: updated broken links --- README.md | 8 ++++---- docs/cli-commands/assessments/validate.md | 2 +- docs/cli-commands/tools/lint.md | 2 +- docs/getting-started/develop-a-validation.md | 2 +- docs/reference/README.md | 2 +- lula.svg => images/lula.svg | 0 6 files changed, 8 insertions(+), 8 deletions(-) rename lula.svg => images/lula.svg (100%) diff --git a/README.md b/README.md index 92ac40c9..27857a23 100644 --- a/README.md +++ b/README.md @@ -3,7 +3,7 @@ [![Go version](https://img.shields.io/github/go-mod/go-version/defenseunicorns/lula?filename=go.mod)](https://go.dev/) [![OpenSSF Scorecard](https://api.securityscorecards.dev/projects/github.com/defenseunicorns/lula/badge)](https://api.securityscorecards.dev/projects/github.com/defenseunicorns/lula) -lula logo +lula logo Lula is a tool designed to bridge the gap between expected configuration required for compliance and **_actual_** configuration. @@ -24,7 +24,7 @@ Cloud-Native Infrastructure, Platforms, and Applications can establish [OSCAL do These controls can be well established and regulated standards such as NIST 800-53. They can also be best practices, Enterprise Standards, or simply team development standards that need to be continuously monitored and validated. -Lula operates on a framework of proof by adding custom overlays mapped to the these controls, [`Lula Validations`](link), to measure system compliance. These `Validations` are constructed by establishing the collection of measurements about a system, given by the specified **Domain**, and the evaluation of adherence, performed by the **Provider**. +Lula operates on a framework of proof by adding custom overlays mapped to the these controls, [`Lula Validations`](./docs/reference/README.md), to measure system compliance. These `Validations` are constructed by establishing the collection of measurements about a system, given by the specified **Domain**, and the evaluation of adherence, performed by the **Provider**. ### Providers and Domains @@ -40,8 +40,8 @@ Lula operates on a framework of proof by adding custom overlays mapped to the th | Provider | Current | Roadmap | |----------|----------|----------| -| [OPA](./docs/reference/provideres/opa-provider.md) | ✅ | - | -| [Kyverno](./docs/reference/provideres/kyverno-provider.md) | ✅ | - | +| [OPA](./docs/reference/providers/opa-provider.md) | ✅ | - | +| [Kyverno](./docs/reference/providers/kyverno-provider.md) | ✅ | - | ## Getting Started diff --git a/docs/cli-commands/assessments/validate.md b/docs/cli-commands/assessments/validate.md index 93a7d74c..2260948f 100644 --- a/docs/cli-commands/assessments/validate.md +++ b/docs/cli-commands/assessments/validate.md @@ -19,4 +19,4 @@ lula validate -f /path/to/oscal-component.yaml This command is used both locally as an evaluation of the Component Definition to understand the component's compliance. It's also implemented in CI workflows to continually evaluate the evolution of a system during development. See the following relevant tutorials: -- ... \ No newline at end of file +* [Simple Demo](../../getting-started/simple-demo.md) \ No newline at end of file diff --git a/docs/cli-commands/tools/lint.md b/docs/cli-commands/tools/lint.md index 613d5716..51afb7f6 100644 --- a/docs/cli-commands/tools/lint.md +++ b/docs/cli-commands/tools/lint.md @@ -2,7 +2,7 @@ The `lula tools lint` command is used to validate OSCAL files against the OSCAL schema. It can validate both composed and non-composed OSCAL models. > **Note**: the `lint` command does not compose the OSCAL model. -> If you want to validate a composed OSCAL model, you should use the [`lula tools compose`](../compose/README.md) command first. +> If you want to validate a composed OSCAL model, you should use the [`lula tools compose`](./compose/README.md) command first. ## Usage diff --git a/docs/getting-started/develop-a-validation.md b/docs/getting-started/develop-a-validation.md index ebb881e0..77681e67 100644 --- a/docs/getting-started/develop-a-validation.md +++ b/docs/getting-started/develop-a-validation.md @@ -1,6 +1,6 @@ # Develop a Validation -This document describes some best practices for developing and using a [Lula Validation](), the primary mechanism for evaluation of system's compliance against a specified control. +This document describes some best practices for developing and using a [Lula Validation](../reference/README.md), the primary mechanism for evaluation of system's compliance against a specified control. ## About diff --git a/docs/reference/README.md b/docs/reference/README.md index de0b207f..bb3e504e 100644 --- a/docs/reference/README.md +++ b/docs/reference/README.md @@ -70,7 +70,7 @@ Linting is done by Lula when a `Validation` object is converted to a `LulaValida The `common.Validation.Lint` method is a convenience method to lint a `Validation` object. It performs the following step: 1. **Marshalling**: The method marshals the `Validation` object into a YAML byte array using the `common.Validation.MarshalYaml` function. -2. **Linting**: The method runs linting against the marshalled `Validation` object. This is done using the `schemas.Validate` function, which ensures that the YAML data conforms to the expected [schema](../../src/pkg/common/schemas/validation.json). +2. **Linting**: The method runs linting against the marshalled `Validation` object. This is done using the `schemas.Validate` function, which ensures that the YAML data conforms to the expected [schema](https://raw.githubusercontent.com/defenseunicorns/lula/main/src/pkg/common/schemas/validation.json). ___ The `schemas.Validate` function is responsible for validating the provided data against a specified JSON schema using [github.com/santhosh-tekuri/jsonschema/v5](https://github.com/santhosh-tekuri/jsonschema). The process involves the following steps: diff --git a/lula.svg b/images/lula.svg similarity index 100% rename from lula.svg rename to images/lula.svg