Skip to content

Commit

Permalink
Prepare docs for OpenSSF Migration
Browse files Browse the repository at this point in the history
Signed-off-by: Luke Hinds <[email protected]>
  • Loading branch information
lukehinds committed Oct 5, 2024
1 parent 49f192a commit 199297f
Show file tree
Hide file tree
Showing 13 changed files with 111 additions and 48 deletions.
13 changes: 5 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@

# What is Minder?

Minder by [Stacklok](https://stacklok.com/) is an open source platform that helps development teams and open source communities build more
Minder is an open source platform that helps development teams and open source communities build more
secure software, and prove to others that what they’ve built is secure. Minder helps project owners proactively manage
their security posture by providing a set of checks and policies to minimize risk along the software supply chain,
and attest their security practices to downstream consumers.
Expand All @@ -17,7 +17,7 @@ Minder allows users to enroll repositories and define policy to ensure repositor
consistently and securely. Policies can be set to alert only or auto-remediate. Minder provides a predefined set of
rules and can also be configured to apply custom rules.

Minder can be deployed as a Helm chart and provides a CLI tool `minder`. Stacklok, the company behind Minder, also
Minder can be deployed as a Helm chart and provides a CLI tool `minder`. Stacklok, a company supporting Minder, also
provides a free-to-use hosted version of Minder (for public repositories only). Minder is designed to be extensible,
allowing users to integrate with their existing tooling and processes.

Expand All @@ -26,14 +26,11 @@ allowing users to integrate with their existing tooling and processes.
* **Repo configuration and security:** Simplify configuration and management of security settings and policies across repos.
* **Proactive security enforcement:** Continuously enforce best practice security configurations by setting granular policies to alert only or auto-remediate.
* **Artifact attestation:** Continuously verify that packages are signed to ensure they’re tamper-proof, using the open source project Sigstore.
* **Dependency management:** Manage dependency security posture by helping developers make better choices and enforcing controls. Minder is integrated with [Trusty by Stacklok](https://trustypkg.dev) to enable policy-driven dependency management based on the risk level of dependencies.
* **Dependency management:** Manage dependency security posture by helping developers make better choices and enforcing controls. Minder is integrated with [OSV](https://osv.dev/) and [Trusty](https://trustypkg.dev) to enable policy-driven dependency management based on the risk level of dependencies.

## Minder Cloud
## Public Instance

Stacklok, the company behind Minder, provides a [free-to-use SaaS version of Minder](https://cloud.stacklok.com/) that includes a UI (for public repositories only). You can access Minder Cloud documentation [here](https://docs.stacklok.com/minder).

Note that it's not possible to register private repositories. If you'd like to use Minder with private repositories,
feel free to [contact us](mailto:[email protected])! We'd be thrilled to help you out.
Stacklok, a company supporting Minder, provides a free-to-use SaaS version of Minder at api.stacklok.com. This instance is available for public repositories only.

---
# Getting Started (< 1 minute)
Expand Down
3 changes: 0 additions & 3 deletions docs/docs/about/changelog.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,9 +17,6 @@ sidebar_position: 30
* **Manage all GitHub repositories** - Jul 17, 2024
Minder can now (optionally) manage all repositories within a GitHub organization, including new repositories that are created. Administrators can continue to select individual repositories to manage.

* **Minder Web** - Apr 16, 2024
Minder Cloud now has a graphical user interface available at [https://cloud.stacklok.com/](https://cloud.stacklok.com/).

* **Built-in rules** - Apr 6, 2024
Minder now includes all the rules in our [sample rules repository](https://github.com/stacklok/minder-rules-and-profiles/) in your new projects automatically. This means that you do not need to clone that repository or add those rule types to make use of them.

Expand Down
2 changes: 1 addition & 1 deletion docs/docs/getting_started/install_cli.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ sidebar_position: 10

# Installing the Minder CLI

The open source Minder CLI can communicate with either [Minder Cloud](https://cloud.stacklok.com/), Stacklok's free-to-use, cloud-hosted version of Minder, or with an on-premises version of Minder that has been [set up independently](../run_minder_server/run_the_server).
The open source Minder CLI can communicate with either the free public instance provided by Stacklok api.stacklok.com, Stacklok's or with a self managed server [set up independently](../run_minder_server/run_the_server).

The `minder` CLI is built for `amd64` and `arm64` architectures on Windows, MacOS, and Linux.

Expand Down
7 changes: 4 additions & 3 deletions docs/docs/getting_started/login.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,17 +7,18 @@ sidebar_position: 20

To start using Minder, you must first log in. Logging in to a Minder server for the first time will create your account.

By default, the Minder CLI will log in to [Minder Cloud](https://cloud.minder.com/), Stacklok's hosted instance of Minder. If you have a separate instance of Minder, you can log in to that server instead.
By default, the Minder CLI will log in to api.stacklok.com, a free public instance provided by Stacklok. If you have
your own hosted instance of Minder, you can log in to that server instead.

## Prerequisites

Before you can log in, you must have [installed the `minder` CLI application](install_cli).

## Logging in to the Stacklok-hosted instance

The `minder` CLI defaults to using the hosted Stacklok environment. When using the hosted environment, you do not need to set up a server; you simply log in to the Stacklok authentication instance using your GitHub credentials.
The `minder` CLI defaults to using the hosted Stacklok public instance. When using the hosted environment, you do not need to set up a server; you simply log in to the Stacklok authentication instance using your GitHub credentials.

You can use the Stacklok hosted environment by running:
You can use the Stacklok public instance by running:

```bash
minder auth login
Expand Down
10 changes: 4 additions & 6 deletions docs/docs/how-to/create_project.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,11 +21,9 @@ project.

## Creating a New Project

To create a new project, enable the Minder GitHub application
([Minder by Stacklok](https://github.com/apps/minder-by-stacklok) for the
cloud-hosted application) on a new GitHub organization. If the GitHub App is
installed on a GitHub organization which is not already registered in Minder,
Minder will create a new project to manage those resources. Using
[`minder provider enroll`](../ref/cli/minder_provider_enroll.md) within a
To create a new project, enable a minder [GitHub application](../run_minder_server/config_provider.md)
on a GitHub organization or user account. If the GitHub App is installed on a GitHub organization
which is not already registered in Minder, Minder will create a new project to
manage those resources. Using [`minder provider enroll`](../ref/cli/minder_provider_enroll.md) within a
project to add a new GitHub provider will _not_ create a new project and will
add the selected organization to an existing project.
9 changes: 4 additions & 5 deletions docs/docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ sidebar_position: 1

# What is Minder?

Minder by Stacklok is an open source platform that helps development teams and open source communities build more secure software, and prove to others that what they’ve built is secure. Minder helps project owners proactively manage their security posture by providing a set of checks and policies to minimize risk along the software supply chain, and attest their security practices to downstream consumers.
Minder is an open source platform that helps development teams and open source communities build more secure software, and prove to others that what they’ve built is secure. Minder helps project owners proactively manage their security posture by providing a set of checks and policies to minimize risk along the software supply chain, and attest their security practices to downstream consumers.

Minder allows users to enroll repositories and define policy to ensure repositories and artifacts are configured consistently and securely. Policies can be set to alert only or autoremediate. Minder provides a predefined set of rules and can also be configured to apply custom rules.

Expand All @@ -18,12 +18,11 @@ Minder can be deployed as a Helm chart and provides a CLI tool ‘minder’. Min
* **Repo configuration and security:** Simplify configuration and management of security settings and policies across repos.
* **Proactive security enforcement:** Continuously enforce best practice security configurations by setting granular policies to alert only or auto-remediate.
* **Artifact attestation:** Continuously verify that packages are signed to ensure they’re tamper-proof, using the open source project Sigstore.
* **Dependency management:** Manage dependency security posture by helping developers make better choices and enforcing controls. Minder is integrated with [Trusty by Stacklok](http://trustypkg.dev) to enable policy-driven dependency management based on the risk level of dependencies.
* **Dependency management:** Manage dependency security posture by helping developers make better choices and enforcing controls. Minder is integrated with [OSV](https://osv.dev/) and [Trusty](https://trustypkg.dev) to enable policy-driven dependency management based on the risk level of dependencies.

## Minder Cloud
## Minder Public Instance

Stacklok, the company behind Minder, provides a free-to-use SaaS version of Minder that includes a UI (for public repositories only).
You can access Minder Cloud at [https://cloud.stacklok.com/](https://cloud.stacklok.com) and access documentation at [https://docs.stacklok.com/minder](https://docs.stacklok.com/minder).
Stacklok, a company supporting Minder, provides a free-to-use public instance of Minder at api.stacklok.com. This instance is available for public repositories only.

## Status

Expand Down
26 changes: 5 additions & 21 deletions docs/docusaurus.config.js
Original file line number Diff line number Diff line change
Expand Up @@ -91,12 +91,12 @@ const config = {
respectPrefersColorScheme: false,
},
// Replace with your project's social card
image: 'img/Stacklok_darkMode_b.png',
image: 'img/Minder_darkMode.png',
navbar: {
title: 'Minder docs',
logo: {
alt: 'Stacklok Logo',
src: 'img/Stacklok_darkMode_b.png',
alt: 'Minder Logo',
src: 'img/Minder_darkMode.png',
},
items: [
// {
Expand Down Expand Up @@ -130,31 +130,15 @@ const config = {
{
title: 'Community',
items: [
{
label: 'Website',
href: 'https://stacklok.com',
},
{
label: 'Twitter',
href: 'https://twitter.com/StackLokHQ',
},
],
},
{
title: 'More',
items: [
{
label: 'Blog',
to: 'https://www.stacklok.com/blog',
},
{
label: 'GitHub',
href: 'https://github.com/stacklok/minder',
},
],
},
],
copyright: `Copyright © ${new Date().getFullYear()} Stacklok, Inc. Built with Docusaurus.`,
copyright: `Copyright © ${new Date().getFullYear()} Minder a Series of LF Projects, LLC
For web site terms of use, trademark policy and other project policies please see https://lfprojects.org.. Built with Docusaurus.`,
},
prism: {
theme: lightCodeTheme,
Expand Down
88 changes: 88 additions & 0 deletions docs/static/img/Minder-whitetxt.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/static/img/Minder.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/static/img/Minder_darkMode.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file removed docs/static/img/Stacklok_darkMode_b.png
Binary file not shown.
Binary file removed docs/static/img/stacklok-favicon.png
Binary file not shown.
Loading

0 comments on commit 199297f

Please sign in to comment.