Skip to content

Commit

Permalink
Added links for doc locations.
Browse files Browse the repository at this point in the history
Signed-off-by: hayleycd <[email protected]>
  • Loading branch information
hayleycd committed Dec 9, 2024
1 parent 53da8e2 commit 6041d3b
Showing 1 changed file with 25 additions and 19 deletions.
44 changes: 25 additions & 19 deletions content/en/about/doc_locations.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ This document describes where to house new Sigstore documentation based on topic
The location for Sigstore repositories and associated documentation is at [http://github.com/sigstore](http://github.com/sigstore). Documentation for Sigstore falls under two main categories:

- **Documentation for Sigstore users**: those who want to sign or verify artifacts or create integrations with using tooling.

Check failure on line 13 in content/en/about/doc_locations.md

View workflow job for this annotation

GitHub Actions / markdownlint

Trailing spaces

content/en/about/doc_locations.md:13:126 MD009/no-trailing-spaces Trailing spaces [Expected: 0 or 2; Actual: 3] https://github.com/DavidAnson/markdownlint/blob/v0.29.0/doc/md009.md
- **Documentation for Sigstore**: those who are changing the modules (Cosign, Rekor, etc.) of Sigstore, adding support for new languages, or implementing new features for the Sigstore suite of tooling.
- **Documentation for Sigstore Developers**: those who are changing the modules (Cosign, Rekor, etc.) of Sigstore, adding support for new languages, or implementing new features for the Sigstore suite of tooling.

Check failure on line 14 in content/en/about/doc_locations.md

View workflow job for this annotation

GitHub Actions / markdownlint

Trailing spaces

content/en/about/doc_locations.md:14:213 MD009/no-trailing-spaces Trailing spaces [Expected: 0 or 2; Actual: 1] https://github.com/DavidAnson/markdownlint/blob/v0.29.0/doc/md009.md

Documentation for users is on the website [https://docs.sigstore.dev](https://docs.sigstore.dev) and the website [https://sigstore.dev](https://sigstore.dev). Sigstore.dev contains a marketing-type first look into what Sigstore is and how it works, while docs.sigstore.dev contains instructions on how to use the software.

Expand All @@ -31,29 +31,35 @@ The documentation for both websites are in the Github repository under the **con

The documentation stored in docs.sigstore.dev is further broken down into various main topics:

- **About**: Overview and general information about the Sigstore product.
- **Signing**: Information about various ways to sign artifacts.
- **Verifying**: Information about how to verify a signed artifact.
- **Key Management**: If a user decides to implement their own key management system instead of using the preferred Sigstore -managed keys, this section provides information about how to manage keys for use with Sigstore.
- **Policy Controller**: Kubernetes policy controller information.
- **System Configuration**: Information on installing and deploying Sigstore.
- **Certificate Authority**: Information on Fulcio, the Sigstore certificate authority.
- **Transparency Log**: Information about Rekkor, the Sigstore logging software.
- [**About**](../../about/overview): Overview and general information about the Sigstore product.
- [**Quickstart**](../../quickstart/quickstart-cosign): A step by step guides to basic Sigstore features.
- [**Signing**](../../cosign/signing/overview): Information about how to sign artifacts.
- [**Verifying**](../../cosign/verifying/verify): Information about how to verify a signed artifact.
- [**Key Management**](../../cosign/key_management/overview): If a user decides to implement their own key management system instead of using the preferred Sigstore -managed keys, this section provides information about how to manage keys for use with Sigstore.
- [**Policy Controller**](../../policy-controller/overview): Kubernetes policy controller information.
- [**System Configuration**](../../cosign/system_config/installation): Information on installing and deploying Sigstore.
- [**Certificate Authority**](../../certificate_authority/overview): Information on Fulcio, the Sigstore certificate authority.
- [**Transparency Log**](../../logging/overview): Information about Rekkor, the Sigstore logging software.
- [**Language Clients**](../../language_clients/language_client_overview): Information on Sigstore language clients


Check failure on line 45 in content/en/about/doc_locations.md

View workflow job for this annotation

GitHub Actions / markdownlint

Multiple consecutive blank lines

content/en/about/doc_locations.md:45 MD012/no-multiple-blanks Multiple consecutive blank lines [Expected: 1; Actual: 2] https://github.com/DavidAnson/markdownlint/blob/v0.29.0/doc/md012.md
## Developer Documentation

Developer documentation is with the repositories for the software. This documentation describes the internal workings of the various pieces of software that make up Sigstore. The repositories are broken down as follows:

- **Helm-charts**: Helm charts for the sigstore project.
- **Policy-controller**: The Kubernetes policy controller software.
- **Cosign**: Signing and verifying software.
- **Sigstore**: Common go library shared across Sigstore services and clients.
- **Sigstore-python**: A code signing tool for Python packages.
- **Sigstore-java**: A code signing library for Java. Also includes Gradle and Maven plugins for build tool integration.
- **Community**: A general Sigstore community repository.
- **Sigstore-website**: The codebase for sigstore.dev.
- **Cosign-installer**: Cosign Github action.
- **Sigstore-js**: Code signing for npm packages.
- [**Helm-charts**](https://github.com/sigstore/helm-charts): Helm charts for the sigstore project.
- [**Policy-controller**](https://github.com/sigstore/policy-controller): The Kubernetes policy controller software.
- [**Cosign**](https://github.com/sigstore/cosign): Signing and verifying software.

Check failure on line 52 in content/en/about/doc_locations.md

View workflow job for this annotation

GitHub Actions / markdownlint

Trailing spaces

content/en/about/doc_locations.md:52:84 MD009/no-trailing-spaces Trailing spaces [Expected: 0 or 2; Actual: 1] https://github.com/DavidAnson/markdownlint/blob/v0.29.0/doc/md009.md
- [**Sigstore**](https://github.com/sigstore/sigstore): Common go library shared across Sigstore services and clients.
- [**Sigstore-python**](https://github.com/sigstore/sigstore-python): A code signing tool for Python packages.
- [**Sigstore-java**](https://github.com/sigstore/sigstore-java): A code signing library for Java. Also includes Gradle and Maven plugins for build tool integration.
- [**Sigstore-js**](https://github.com/sigstore/sigstore-js): Code signing for npm packages.
- [**Sigstore-go**](https://github.com/sigstore/sigstore-go): Go library for Sigstore signing and verification.
- [**Sigstore-ruby**](https://github.com/sigstore/sigstore-ruby): Pure-Ruby implementation of Sigstore verification.
- [**Sigstore-rs**](https://github.com/sigstore/sigstore-rs): An experimental Rust crate for Sigstore.
- [**Community**](https://github.com/sigstore/community): A general Sigstore community repository.
- [**Sigstore-website**](https://github.com/sigstore/sigstore-website): The codebase for sigstore.dev.
- [**Cosign-installer**](https://github.com/sigstore/cosign-installer): Cosign Github action.


Check failure on line 64 in content/en/about/doc_locations.md

View workflow job for this annotation

GitHub Actions / markdownlint

Multiple consecutive blank lines

content/en/about/doc_locations.md:64 MD012/no-multiple-blanks Multiple consecutive blank lines [Expected: 1; Actual: 2] https://github.com/DavidAnson/markdownlint/blob/v0.29.0/doc/md012.md
Each of the above repositories has at least a readme.md file. Most have a doc or content folder to contain documentation.

0 comments on commit 6041d3b

Please sign in to comment.