Skip to content

Commit

Permalink
Addressing linter comments
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 6041d3b commit b8d12bd
Showing 1 changed file with 6 additions and 9 deletions.
15 changes: 6 additions & 9 deletions content/en/about/doc_locations.md
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 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 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,7 +24,6 @@ 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
Expand All @@ -40,18 +39,17 @@ The documentation stored in docs.sigstore.dev is further broken down into variou
- [**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

- [**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**](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.
- [**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-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.
Expand All @@ -61,5 +59,4 @@ Developer documentation is with the repositories for the software. This document
- [**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.

0 comments on commit b8d12bd

Please sign in to comment.