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.

Sign up for GitHub

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

Jump to bottom

Combine profile introduction and concept #1548

Merged
merged 1 commit into from
Nov 6, 2023
Merged

Combine profile introduction and concept #1548

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
0 docs/docs/about/_category.yml_ → docs/docs/about/_category_.yml
View file
Open in desktop
File renamed without changes.
2 changes: 1 addition & 1 deletion docs/docs/how-to/create_profile.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Creating a profile
sidebar_position: 30
sidebar_position: 10
---

## Prerequisites
Expand Down
21 changes: 0 additions & 21 deletions docs/docs/how-to/profile_introduction.md
View file
Open in desktop

This file was deleted.

14 changes: 12 additions & 2 deletions docs/docs/understand/profiles.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,13 +5,23 @@ sidebar_position: 20

# Profiles in Minder

Minder allows you to define profiles for your software supply chain.

Profiles in Minder allow you to group and manage
rules for various entity types, such as repositories, pull requests, and artifacts, across your registered GitHub
repositories.

Profiles are defined in a YAML file and can be configured to meet your compliance requirements.
The anatomy of a profile is the profile itself, which outlines the rules to be
checked, the rule types, and the evaluation engine. Profiles are defined in a YAML file and can be configured to meet your compliance requirements.
As of time of writing, Minder supports the following evaluation engines:

* **[Open Profile Agent](https://www.openprofileagent.org/)** (OPA) profile language.
* **[JQ](https://jqlang.github.io/jq/)** - a lightweight and flexible command-line JSON processor.

Each engine is designed to be extensible, allowing you to integrate your own
logic and processes.

You can find a list of available profiles in the [https://github.com/stacklok/minder-rules-and-profiles](https://github.com/stacklok/minder-rules-and-profiles/tree/main/profiles/github) repository.
Stacklok has published [a set of example profiles on GitHub](https://github.com/stacklok/minder-rules-and-profiles/tree/main/profiles/github); see [Managing Profiles](../how-to/manage_profiles.md) for more details on how to set up profiles and rule types.

## Rules

Expand Down