Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Added links for doc locations. #355

Merged
merged 2 commits into from
Dec 9, 2024
Merged

Added links for doc locations. #355

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
6041d3b
Added links for doc locations.
hayleycd Dec 9, 2024
b8d12bd
Addressing linter comments
hayleycd Dec 9, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
49 changes: 26 additions & 23 deletions content/en/about/doc_locations.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,12 +6,12 @@ title: Documentation Locations
weight: 33
---

This document describes where to house new Sigstore documentation based on topic and intended audience.
This document describes where to house new Sigstore documentation based on topic and intended audience.

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.
- **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 users**: those who want to sign or verify artifacts or create integrations with using 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.

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 @@ -24,36 +24,39 @@ User documentation is in two github repositories:
- [https://github.com/sigstore/docs](https://github.com/sigstore/docs): This repository contains the information for docs.sigstore.dev
- [https://github.com/sigstore/sigstore-website](https://github.com/sigstore/sigstore-website): This repository contains the information for sigstore.dev


The documentation for both websites are in the Github repository under the **content** folder.

### Sigstore Docs

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.

## 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.
- [**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.

Each of the above repositories has at least a readme.md file. Most have a doc or content folder to contain documentation.
Loading