Skip to content

Commit

Permalink
addressing comments and reorg.
Browse files Browse the repository at this point in the history
Signed-off-by: hayleycd <[email protected]>
  • Loading branch information
hayleycd committed Nov 19, 2024
2 parents c501a7a + d0c5d64 commit 2df369f
Show file tree
Hide file tree
Showing 11 changed files with 30 additions and 84 deletions.
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
---
type: docs
category: Go
title: Go Client Overview
weight: 5
category: Language Clients
title: Go
weight: 10
---

[`sigstore-go`](https://pkg.go.dev/github.com/sigstore/sigstore-go) is the Go language client library for Sigstore.
Expand Down
11 changes: 0 additions & 11 deletions content/en/language_clients/go/_index.html

This file was deleted.

Original file line number Diff line number Diff line change
@@ -1,17 +1,17 @@
---
type: docs
category: Java
title: Java Client Overview
weight: 5
category: Language Clients
title: Java
weight: 20
---

[`sigstore-java`](https://github.com/sigstore/sigstore-java#sigstore-java) is a java client for interacting with the Sigstore infrastructure.

## Features

- Includes both [Maven](https://github.com/sigstore/sigstore-java/tree/main/sigstore-maven-plugin) and [Gradle](https://github.com/sigstore/sigstore-java/tree/main/sigstore-gradle) build plugins
- [Maven](https://github.com/sigstore/sigstore-java/tree/main/sigstore-maven-plugin) and [Gradle](https://github.com/sigstore/sigstore-java/tree/main/sigstore-gradle) signing plugins
- Keyless signing and verifying
- [API](https://javadoc.io/doc/dev.sigstore/sigstore-java)
- Java native signing and verifying [API](https://javadoc.io/doc/dev.sigstore/sigstore-java)

## Installation

Expand Down Expand Up @@ -51,9 +51,9 @@ plugins {

More information on the Gradle build plugin is available in the [project repository](https://github.com/sigstore/sigstore-java/tree/main/sigstore-gradle#sigstore-gradle).

## Example
## API Usage Examples

### Signing example
### Signing

```java
Path testArtifact = Paths.get("path/to/my/file.jar")
Expand All @@ -66,7 +66,7 @@ Bundle result = signer.signFile(testArtifact);
String bundleJson = result.toJson();
```

### Verifying example
### Verifying

#### Get artifact and bundle

Expand Down Expand Up @@ -104,4 +104,4 @@ try {

### Additional examples

[Additional](https://github.com/sigstore/sigstore-java/tree/main/examples/hello-world#sigstore-examples) [examples](https://github.com/sigstore/sigstore-java/tree/main/examples/pgp#pgp-test-keys-for-examples) are available in the project repository.
[Additional](https://github.com/sigstore/sigstore-java/tree/main/examples/hello-world#sigstore-examples) [examples](https://github.com/sigstore/sigstore-java/tree/main/examples/pgp#pgp-test-keys-for-examples) are available in the project repository.

Check failure on line 107 in content/en/language_clients/java.md

View workflow job for this annotation

GitHub Actions / markdownlint

Files should end with a single newline character

content/en/language_clients/java.md:107:249 MD047/single-trailing-newline Files should end with a single newline character https://github.com/DavidAnson/markdownlint/blob/v0.29.0/doc/md047.md
11 changes: 0 additions & 11 deletions content/en/language_clients/java/_index.html

This file was deleted.

Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
---
type: docs
category: JavaScript
title: JavaScript Client Overview
weight: 5
category: Language Clients
title: JavaScript
weight: 30
---

[sigstore-js](https://github.com/sigstore/sigstore-js) is a collection of [javascript libraries](#additional-packages) for interacting with Sigstore.
Expand Down
11 changes: 0 additions & 11 deletions content/en/language_clients/javascript/_index.html

This file was deleted.

17 changes: 9 additions & 8 deletions content/en/language_clients/language_client_overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,13 +7,14 @@ weight: 5

Sigstore uses [cosign](../../cosign/signing/overview) to sign and verify packages by default, but you can opt to use a language specific client instead.

Sigstore has clients for the following language ecosystems:
Language client summaries are available in the main Sigstore documentation, but complete documentation is hosted in the individual project repositories.

- [Go](../go/overview)
- [Java](../java/overview)
- [JavaScript](../javascript/overview)
- [Python](../python/overview)
- [Rust](../rust/overview)
- [Ruby](https://github.com/sigstore/sigstore-ruby#sigstore)
| Language Client Summary | Project Repository |
| ---------------------------------------- | -------------------------------------------------------------- |
| [Go](../go) | [sigstore-go](https://github.com/sigstore/sigstore-go) |
| [Java](../java) | [sigstore-java](https://github.com/sigstore/sigstore-java) |
| [Javascript](../javascript) | [sigstore-js](https://github.com/sigstore/sigstore-js) |
| [Python](../python) | [sigstore-python](https://github.com/sigstore/sigstore-python) |
| Ruby (available soon) | [sigstore-ruby](https://github.com/sigstore/sigstore-ruby) |
| [Rust](../rust) | [sigstore-rs](https://github.com/sigstore/sigstore-rs) |

Language client documentation is hosted in the individual project repositories. Project summaries are currently being added to the main Sigstore documentation.
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
---
type: docs
category: Python
title: Python Client Overview
weight: 5
category: Language Clients
title: Python
weight: 40
---

[`sigstore`](https://pypi.org/project/sigstore/) is a Python tool for generating and verifying Sigstore signatures. You can use it to sign and verify Python package distributions, or anything else!
Expand Down
11 changes: 0 additions & 11 deletions content/en/language_clients/python/_index.html

This file was deleted.

Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
---
type: docs
category: Rust
title: Rust Client Overview
weight: 5
category: Language Clients
title: Rust
weight: 50
---

[`sigstore`](https://crates.io/crates/sigstore) is a crate designed to interact with Sigstore architecture.
Expand Down
11 changes: 0 additions & 11 deletions content/en/language_clients/rust/_index.html

This file was deleted.

0 comments on commit 2df369f

Please sign in to comment.