Skip to content

Commit

Permalink
Enable secret scanning doc to "Creating your first profile" (#1505)
Browse files Browse the repository at this point in the history
* Enable secret scanning doc to "Creating your first profile"

This is more appropriate for the "getting started" section and reflects
the intention better.

* fix dangling references
  • Loading branch information
JAORMX authored Nov 6, 2023
1 parent ccc3401 commit 6712ee4
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 7 deletions.
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
---
title: Enabling Secret Scanning
title: Creating your first profile
sidebar_position: 40
---

# Enabling Secret Scanning using Minder Profiles
# Creating your first profile

Minder uses [profiles](../how-to/create_profile.md) to specify common,
consistent configuration which should be enforced on all registered
Expand Down
10 changes: 5 additions & 5 deletions docs/docs/getting_started/remediations.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ sidebar_position: 70

# Automatic Remediation with Minder

In [Enabling Secret Scanning](./secret_scanning.md), we wrote a rule to open a
In [Enabling Secret Scanning](./first_profile.md), we wrote a rule to open a
security advisory when repo configuration drifted from the configured profile
in Minder. In this tutorial, we will show how Minder can automatically
resolve the misconfiguration and ensure that enrolled repos have secret
Expand All @@ -18,15 +18,15 @@ it will remediate (fix) the setting if it is changed to violate the profile.
* [The `minder` CLI application](./install_cli.md)
* [A Minder account](./login.md)
* [An enrolled GitHub token](./login.md#enrolling-the-github-provider) that is either an Owner in the organization or an Admin on the repositories
* [A registered repository in Minder](./secret_scanning.md#register-repositories)
* [The `secret_scanning`` rule type](./secret_scanning.md#creating-and-applying-profiles)
* [A policy to open security advisories when secret scanning is off](./secret_scanning.md#creating-and-applying-profiles)
* [A registered repository in Minder](./first_profile.md#register-repositories)
* [The `secret_scanning`` rule type](./first_profile.md#creating-and-applying-profiles)
* [A policy to open security advisories when secret scanning is off](./first_profile.md#creating-and-applying-profiles)

## Creating a profile with `remediate: on`

Minder doesn't currently support editing profiles, so we will create a new profile with `remediate: on`.

Edit the YAML file of the [profile from the secret-scanning tutorial](./secret_scanning.md#creating-and-applying-profiles)
Edit the YAML file of the [profile from the secret-scanning tutorial](./first_profile.md#creating-and-applying-profiles)
and set the `remediate` attribute to `on`:
```yaml
---
Expand Down

0 comments on commit 6712ee4

Please sign in to comment.