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

docs: updated broken links #554

Merged
merged 1 commit into from
Jul 24, 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
8 changes: 4 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)

<img align="right" alt="lula logo" src="lula.svg" height="256" />
<img align="right" alt="lula logo" src="./images/lula.svg" height="256" />

Lula is a tool designed to bridge the gap between expected configuration required for compliance and **_actual_** configuration.

Expand All @@ -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

Expand All @@ -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

Expand Down
2 changes: 1 addition & 1 deletion docs/cli-commands/assessments/validate.md
Original file line number Diff line number Diff line change
Expand Up @@ -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:

- ...
* [Simple Demo](../../getting-started/simple-demo.md)
2 changes: 1 addition & 1 deletion docs/cli-commands/tools/lint.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
2 changes: 1 addition & 1 deletion docs/getting-started/develop-a-validation.md
Original file line number Diff line number Diff line change
@@ -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

Expand Down
2 changes: 1 addition & 1 deletion docs/reference/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down
File renamed without changes