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

Update docs "understand" section #3101

Merged
merged 3 commits into from
Apr 16, 2024
Merged

Update docs "understand" section #3101

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
535d630
Make the page "remediations" for consistency
ethomson Apr 16, 2024
f8312c8
Update links in understand section
ethomson Apr 16, 2024
1ea3410
Update rule type docs to match rule type names
ethomson Apr 16, 2024
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
2 changes: 1 addition & 1 deletion docs/docs/integrations/trusty.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ sidebar_position: 40

Minder integrates directly with [Trusty by Stacklok](http://trustypkg.dev) to enable policy-driven dependency management based on the risk level of dependencies.

Minder provides a [Trusty rule type](../ref/rules/activity.md) which allows you to monitor new pull requests for newly added dependencies with low [Trusty](https://www.trustypkg.dev/) scores.
Minder provides a [Trusty rule type](../ref/rules/pr_trusty_check.md) which allows you to monitor new pull requests for newly added dependencies with low [Trusty](https://www.trustypkg.dev/) scores.

For every pull request submitted to a repository, this rule will check if the pull request adds a new dependency with
a Trusty score below a threshold that you define. If a dependency with a low score is added, Minder will notify you and
Expand Down
0 docs/docs/ref/rules/code_scanning.md → docs/docs/ref/rules/codeql_enabled.md
View file
Open in desktop
File renamed without changes.
0 docs/docs/ref/rules/dependabot.md → docs/docs/ref/rules/dependabot_configured.md
View file
Open in desktop
File renamed without changes.
0 docs/docs/ref/rules/activity.md → docs/docs/ref/rules/pr_trusty_check.md
View file
Open in desktop
File renamed without changes.
0 docs/docs/ref/rules/vulnerabilities.md → .../docs/ref/rules/pr_vulnerability_check.md
View file
Open in desktop
File renamed without changes.
0 docs/docs/ref/rules/secrets.md → docs/docs/ref/rules/secret_scanning.md
View file
Open in desktop
File renamed without changes.
2 changes: 1 addition & 1 deletion docs/docs/understand/alerts.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ sidebar_position: 40

# Alerts from Minder

Minder issues _alerts_ to notify you when the state of your software supply chain does not meet the criteria that you've defined in your [profile](profile).
Minder issues _alerts_ to notify you when the state of your software supply chain does not meet the criteria that you've defined in your [profile](profiles).

Alerts are a core feature of Minder providing you with notifications about the status of your registered
repositories. These alerts automatically open and close based on the evaluation of the rules defined in your profiles.
Expand Down
2 changes: 1 addition & 1 deletion docs/docs/understand/profiles.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ sidebar_position: 10

# Profiles in Minder

A _profile_ defines your security policies that you want to apply to your software supply chain. Profiles contain rules that query data in a [provider](provider), and specifies whether Minder will issue [alerts](alerts) or perform automatic [remediations](remediations) when an entity is not in compliance with the policy.
A _profile_ defines your security policies that you want to apply to your software supply chain. Profiles contain rules that query data in a [provider](providers), and specifies whether Minder will issue [alerts](alerts) or perform automatic [remediations](remediations) when an entity is not in compliance with the policy.

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
Expand Down
2 changes: 1 addition & 1 deletion docs/docs/understand/providers.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ sidebar_position: 20

# Providers in Minder

A _provider_ connects Minder to your software supply chain — giving Minder information about your source code repositories, and their pull requests, dependencies, and artifacts. Minder will apply your [profiles](profiles) to providers to analyze the security posture of your software supply chain, and then will create [alerts](alerts) and can automatically [remediate](remediation) problems that it finds.
A _provider_ connects Minder to your software supply chain — giving Minder information about your source code repositories, and their pull requests, dependencies, and artifacts. Minder will apply your [profiles](profiles) to providers to analyze the security posture of your software supply chain, and then will create [alerts](alerts) and can automatically [remediate](remediations) problems that it finds.

The currently supported providers are:
* GitHub
Expand Down
2 changes: 1 addition & 1 deletion docs/docs/understand/remediation.md → docs/docs/understand/remediations.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ title: Automatic Remediations
sidebar_position: 60
---

# Automatic Remediation in Minder
# Automatic Remediations in Minder

Minder can perform _automatic remediation_ for many rules in an attempt to resolve problems in your software supply chain, and bring your resources into compliance with your [profile](profiles).

Expand Down