From 57ae2252115be0b6ee812d398ccd02de7d74c8e9 Mon Sep 17 00:00:00 2001 From: Evan Anderson Date: Mon, 6 Nov 2023 15:38:55 -0600 Subject: [PATCH] Actually fix category file name --- .../about/{_category.yml_ => _category_.yml} | 0 docs/docs/how-to/create_profile.md | 2 +- docs/docs/how-to/profile_introduction.md | 21 ------------------- docs/docs/understand/profiles.md | 14 +++++++++++-- 4 files changed, 13 insertions(+), 24 deletions(-) rename docs/docs/about/{_category.yml_ => _category_.yml} (100%) delete mode 100644 docs/docs/how-to/profile_introduction.md diff --git a/docs/docs/about/_category.yml_ b/docs/docs/about/_category_.yml similarity index 100% rename from docs/docs/about/_category.yml_ rename to docs/docs/about/_category_.yml diff --git a/docs/docs/how-to/create_profile.md b/docs/docs/how-to/create_profile.md index e032735441..1bc83db8d3 100644 --- a/docs/docs/how-to/create_profile.md +++ b/docs/docs/how-to/create_profile.md @@ -1,6 +1,6 @@ --- title: Creating a profile -sidebar_position: 30 +sidebar_position: 10 --- ## Prerequisites diff --git a/docs/docs/how-to/profile_introduction.md b/docs/docs/how-to/profile_introduction.md deleted file mode 100644 index e6f37313b3..0000000000 --- a/docs/docs/how-to/profile_introduction.md +++ /dev/null @@ -1,21 +0,0 @@ ---- -title: Profile Introduction -sidebar_position: 10 ---- - -# Profile Introduction - -Minder allows you to define profiles for your software supply chain. - -The anatomy of a profile is the profile itself, which outlines the rules to be -checked, the rule types, and the evaluation engine. - -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. - -Please see the [examples](https://github.com/stacklok/minder/tree/main/examples) directory for examples of profiles, and [Manage Profiles](./manage_profiles.md) for more details on how to set up profiles and rule types. diff --git a/docs/docs/understand/profiles.md b/docs/docs/understand/profiles.md index 1b55a9c6af..d408bec949 100644 --- a/docs/docs/understand/profiles.md +++ b/docs/docs/understand/profiles.md @@ -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