Skip to content

Commit

Permalink
Docs: Fix up logos and remove alpha note (#5159)
Browse files Browse the repository at this point in the history
Fix up the logos and remove alpha note

- The purple logo failed contrast accessibility tests, swap for white
- Use the ThemedImage component to swap the right logos for
  dark & light mode on the index page
- Also removes the Alpha status note from the index page
  • Loading branch information
danbarr authored Dec 9, 2024
1 parent dd7a702 commit 1ba2e84
Show file tree
Hide file tree
Showing 3 changed files with 18 additions and 10 deletions.
23 changes: 15 additions & 8 deletions docs/docs/index.md → docs/docs/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -3,29 +3,36 @@ title: Minder
sidebar_position: 1
---

![minder logo](./images/Minder_darkMode.png)
import useBaseUrl from '@docusaurus/useBaseUrl';
import ThemedImage from '@theme/ThemedImage';

<ThemedImage
alt="Minder logo"
sources={{
light: useBaseUrl('/img/Minder.png'),
dark: useBaseUrl('/img/Minder_darkMode.png'),
}}
/>

# What is Minder?

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.

Minder can be deployed as a Helm chart and provides a CLI tool minder. Minder is designed to be extensible, allowing users to integrate with their existing tooling and processes.
Minder can be deployed as a Helm chart and provides a CLI tool 'minder'. Minder is designed to be extensible, allowing users to integrate with their existing tooling and processes.

## Features

* **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 theyre 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 [OSV](https://osv.dev/) and [Stacklok Insight](https://insight.stacklok.com) to enable policy-driven dependency management based on the risk level of dependencies.
- **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 [OSV](https://osv.dev/) and [Stacklok Insight](https://insight.stacklok.com) to enable policy-driven dependency management based on the risk level of dependencies.

## Minder Public Instance

Stacklok, a company supporting Minder, provides a free-to-use public instance of Minder. This is the default instance used when you use the `minder` CLI. This instance is available for public repositories only.

## Status

Minder is currently in _Alpha_, meaning that it is not ready for production use: features and functionality is likely to change.

The public roadmap for Minder is available here: [link](./about/roadmap.md)
2 changes: 1 addition & 1 deletion docs/docusaurus.config.js
Original file line number Diff line number Diff line change
Expand Up @@ -106,7 +106,7 @@ const config = {
title: 'Minder docs',
logo: {
alt: 'Minder Logo',
src: 'img/Minder_darkMode.png',
src: 'img/Minder-whitetxt.svg',
},
items: [
// {
Expand Down
3 changes: 2 additions & 1 deletion 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.

0 comments on commit 1ba2e84

Please sign in to comment.