Skip to content

Commit 6041d3b

Browse files
committed
Added links for doc locations.
Signed-off-by: hayleycd <[email protected]>
1 parent 53da8e2 commit 6041d3b

File tree

1 file changed

+25
-19
lines changed

1 file changed

+25
-19
lines changed

content/en/about/doc_locations.md

Lines changed: 25 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ This document describes where to house new Sigstore documentation based on topic
1111
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:
1212

1313
- **Documentation for Sigstore users**: those who want to sign or verify artifacts or create integrations with using tooling.
14-
- **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.
14+
- **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.
1515

1616
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.
1717

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

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

34-
- **About**: Overview and general information about the Sigstore product.
35-
- **Signing**: Information about various ways to sign artifacts.
36-
- **Verifying**: Information about how to verify a signed artifact.
37-
- **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.
38-
- **Policy Controller**: Kubernetes policy controller information.
39-
- **System Configuration**: Information on installing and deploying Sigstore.
40-
- **Certificate Authority**: Information on Fulcio, the Sigstore certificate authority.
41-
- **Transparency Log**: Information about Rekkor, the Sigstore logging software.
34+
- [**About**](../../about/overview): Overview and general information about the Sigstore product.
35+
- [**Quickstart**](../../quickstart/quickstart-cosign): A step by step guides to basic Sigstore features.
36+
- [**Signing**](../../cosign/signing/overview): Information about how to sign artifacts.
37+
- [**Verifying**](../../cosign/verifying/verify): Information about how to verify a signed artifact.
38+
- [**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.
39+
- [**Policy Controller**](../../policy-controller/overview): Kubernetes policy controller information.
40+
- [**System Configuration**](../../cosign/system_config/installation): Information on installing and deploying Sigstore.
41+
- [**Certificate Authority**](../../certificate_authority/overview): Information on Fulcio, the Sigstore certificate authority.
42+
- [**Transparency Log**](../../logging/overview): Information about Rekkor, the Sigstore logging software.
43+
- [**Language Clients**](../../language_clients/language_client_overview): Information on Sigstore language clients
4244

4345

4446
## Developer Documentation
4547

4648
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:
4749

48-
- **Helm-charts**: Helm charts for the sigstore project.
49-
- **Policy-controller**: The Kubernetes policy controller software.
50-
- **Cosign**: Signing and verifying software.
51-
- **Sigstore**: Common go library shared across Sigstore services and clients.
52-
- **Sigstore-python**: A code signing tool for Python packages.
53-
- **Sigstore-java**: A code signing library for Java. Also includes Gradle and Maven plugins for build tool integration.
54-
- **Community**: A general Sigstore community repository.
55-
- **Sigstore-website**: The codebase for sigstore.dev.
56-
- **Cosign-installer**: Cosign Github action.
57-
- **Sigstore-js**: Code signing for npm packages.
50+
- [**Helm-charts**](https://github.com/sigstore/helm-charts): Helm charts for the sigstore project.
51+
- [**Policy-controller**](https://github.com/sigstore/policy-controller): The Kubernetes policy controller software.
52+
- [**Cosign**](https://github.com/sigstore/cosign): Signing and verifying software.
53+
- [**Sigstore**](https://github.com/sigstore/sigstore): Common go library shared across Sigstore services and clients.
54+
- [**Sigstore-python**](https://github.com/sigstore/sigstore-python): A code signing tool for Python packages.
55+
- [**Sigstore-java**](https://github.com/sigstore/sigstore-java): A code signing library for Java. Also includes Gradle and Maven plugins for build tool integration.
56+
- [**Sigstore-js**](https://github.com/sigstore/sigstore-js): Code signing for npm packages.
57+
- [**Sigstore-go**](https://github.com/sigstore/sigstore-go): Go library for Sigstore signing and verification.
58+
- [**Sigstore-ruby**](https://github.com/sigstore/sigstore-ruby): Pure-Ruby implementation of Sigstore verification.
59+
- [**Sigstore-rs**](https://github.com/sigstore/sigstore-rs): An experimental Rust crate for Sigstore.
60+
- [**Community**](https://github.com/sigstore/community): A general Sigstore community repository.
61+
- [**Sigstore-website**](https://github.com/sigstore/sigstore-website): The codebase for sigstore.dev.
62+
- [**Cosign-installer**](https://github.com/sigstore/cosign-installer): Cosign Github action.
63+
5864

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

0 commit comments

Comments
 (0)