Skip to content

Commit

Permalink
Fixing links and minor cleanup.
Browse files Browse the repository at this point in the history
Signed-off-by: hayleycd <cook.hayley@gmail.com>
  • Loading branch information
hayleycd committed Oct 13, 2024
1 parent 9df0149 commit d1f27bf
Show file tree
Hide file tree
Showing 5 changed files with 9 additions and 43 deletions.
4 changes: 1 addition & 3 deletions content/en/language_clients/python/installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,6 @@ title: Installation
weight: 5
---

## Installation

`sigstore` requires Python 3.8 or newer, and can be installed directly via `pip`:

```console
Expand All @@ -20,4 +18,4 @@ Optionally, to install `sigstore` and all its dependencies with [hash-checking m
python -m pip install -r https://raw.githubusercontent.com/sigstore/sigstore-python/main/install/requirements.txt
```

This installs the requirements file located [here](https://github.com/sigstore/sigstore-python/blob/main/install/requirements.txt), which is kept up-to-date.
This installs the up-to-date [requirements file](https://github.com/sigstore/sigstore-python/blob/main/install/requirements.txt).
31 changes: 5 additions & 26 deletions content/en/language_clients/python/python_client_overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,13 +10,14 @@ weight: 1

## Features

* Support for keyless signature generation and verification with [Sigstore](https://www.sigstore.dev/)
* Support for signing with ["ambient" OpenID Connect identities ](https://github.com/sigstore/sigstore-python#signing-with-ambient-credentials)
* A comprehensive [CLI](https://github.com/sigstore/sigstore-python#usage) and corresponding [importable Python API](https://sigstore.github.io/sigstore-python)
* Supports keyless signature generation and verification
* Supports signing with ["ambient" OpenID Connect identities ](../signing#signing-with-ambient-credentials)

Check failure on line 14 in content/en/language_clients/python/python_client_overview.md

View workflow job for this annotation

GitHub Actions / markdownlint

Spaces inside link text

content/en/language_clients/python/python_client_overview.md:14:25 MD039/no-space-in-links Spaces inside link text [Context: "...t" OpenID Connect identities ]"] https://github.com/DavidAnson/markdownlint/blob/v0.29.0/doc/md039.md
* A comprehensive [CLI](#usage) and corresponding [importable Python API](https://sigstore.github.io/sigstore-python)
* An official [GitHub Action](../github_action)

## Usage

Check failure on line 18 in content/en/language_clients/python/python_client_overview.md

View workflow job for this annotation

GitHub Actions / markdownlint

Trailing spaces

content/en/language_clients/python/python_client_overview.md:18:9 MD009/no-trailing-spaces Trailing spaces [Expected: 0 or 2; Actual: 1] https://github.com/DavidAnson/markdownlint/blob/v0.29.0/doc/md009.md

For Python API usage, see our [documentation](https://sigstore.github.io/sigstore-python/).
For Python API usage, see our [API documentation](https://sigstore.github.io/sigstore-python/).

You can run `sigstore` as a standalone program, or via `python -m`:

Expand Down Expand Up @@ -53,28 +54,6 @@ optional arguments:
```
<!-- @end-sigstore-help@ -->

## Licensing

`sigstore` is licensed under the Apache 2.0 License.

## Community

`sigstore-python` is developed as part of the [Sigstore](https://sigstore.dev) project.

We also use a [Slack channel](https://sigstore.slack.com)! Click [here](https://join.slack.com/t/sigstore/shared_invite/zt-mhs55zh0-XmY3bcfWn4XEyMqUUutbUQ) for the invite link.

## Contributing

See [the contributing docs](https://github.com/sigstore/.github/blob/main/CONTRIBUTING.md) for details.

## Code of Conduct

Everyone interacting with this project is expected to follow the [sigstore Code of Conduct](https://github.com/sigstore/.github/blob/main/CODE_OF_CONDUCT.md).

## Security

Should you discover any security issues, please refer to sigstore's [security process](https://github.com/sigstore/.github/blob/main/SECURITY.md).

### SLSA Provenance

Check failure on line 57 in content/en/language_clients/python/python_client_overview.md

View workflow job for this annotation

GitHub Actions / markdownlint

Headings should be surrounded by blank lines

content/en/language_clients/python/python_client_overview.md:57 MD022/blanks-around-headings/blanks-around-headers Headings should be surrounded by blank lines [Expected: 1; Actual: 0; Below] [Context: "### SLSA Provenance"] https://github.com/DavidAnson/markdownlint/blob/v0.29.0/doc/md022.md
This project emits a SLSA provenance on its release! This enables you to verify the integrity of the downloaded artifacts and ensured that the binary's code really comes from this source code.

Expand Down
14 changes: 3 additions & 11 deletions content/en/language_clients/python/root_of_trust.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,19 +7,11 @@ weight: 30
---
## Configuring a custom root of trust ("BYO PKI")

Apart from the default and "staging" Sigstore instances, `sigstore` also
supports "BYO PKI" setups, where a user maintains their own Sigstore
instance services.
Apart from the default and "staging" Sigstore instances, `sigstore` also supports "BYO PKI" setups, where a user maintains their own Sigstore instance services.

These are supported via the `--trust-config` flag, which accepts a
JSON-formatted file conforming to the `ClientTrustConfig` message
in the [Sigstore protobuf specs](https://github.com/sigstore/protobuf-specs).
This file configures the entire Sigstore instance state, *including* the URIs
used to access the CA and artifact transparency services as well as the
cryptographic root of trust itself.
These are supported via the `--trust-config` flag, which accepts a JSON-formatted file conforming to the `ClientTrustConfig` message in the [Sigstore protobuf specs](https://github.com/sigstore/protobuf-specs). This file configures the entire Sigstore instance state, *including* the URIs used to access the CA and artifact transparency services as well as the cryptographic root of trust itself.

To use a custom client config, prepend `--trust-config` to any `sigstore`
command:
To use a custom client config, prepend `--trust-config` to any `sigstore` command:

```console
$ sigstore --trust-config custom.trustconfig.json sign foo.txt

Check failure on line 17 in content/en/language_clients/python/root_of_trust.md

View workflow job for this annotation

GitHub Actions / markdownlint

Dollar signs used before commands without showing output

content/en/language_clients/python/root_of_trust.md:17:1 MD014/commands-show-output Dollar signs used before commands without showing output [Context: "$ sigstore --trust-config cust..."] https://github.com/DavidAnson/markdownlint/blob/v0.29.0/doc/md014.md
Expand Down
1 change: 0 additions & 1 deletion content/en/language_clients/python/signing.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,6 @@ menuTitle: Signing
title: Signing
weight: 10
---
## Signing

<!-- @begin-sigstore-sign-help@ -->
```
Expand Down
2 changes: 0 additions & 2 deletions content/en/language_clients/python/verifying.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,6 @@ menuTitle: Verifying
title: Verifying
weight: 20
---
## Verifying

### Generic identities

This is the most common verification done with `sigstore`, and therefore
Expand Down

0 comments on commit d1f27bf

Please sign in to comment.