Skip to content

Commit

Permalink
updating docs and removing witness.md
Browse files Browse the repository at this point in the history
Signed-off-by: chaosinthecrd <tom@tmlabs.co.uk>
  • Loading branch information
ChaosInTheCRD committed Jan 19, 2024
1 parent 1603131 commit af4cc5b
Show file tree
Hide file tree
Showing 6 changed files with 12 additions and 27 deletions.
4 changes: 2 additions & 2 deletions docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,10 +17,10 @@ NOTE: MUST CHANGE URL TO LOGO BEFORE MERGING
alt="Witness project logo" width="200"></img>

### What does Witness do?
✏️ **Attests** - <span style={{fontSize: '0.9em'}}>Witness is a dynamic CLI tool that integrates into pipelines and infrastructure to create an
✏️ **Attests** - <span class="tip-text">Witness is a dynamic CLI tool that integrates into pipelines and infrastructure to create an
audit trail for your software's entire journey through the software development lifecycle (SDLC) using the in-toto specification.</span>

**🧐 Verifies** - <span style={{fontSize: '0.9em'}}>Witness also features its own policy engine with embedded support for OPA Rego, so you can
**🧐 Verifies** - <span class="tip-text">Witness also features its own policy engine with embedded support for OPA Rego, so you can
ensure that your software was handled safely from source to deployment.</span>

### What can you do with Witness?
Expand Down
2 changes: 1 addition & 1 deletion docs/tutorials/artifact-policy.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Verifying an Artifact with a Witness Policy

><span style={{fontSize: '0.9em'}}>💡 Tip: If this is your first time using Witness, you might benefit from trying the [Getting Started](./getting-started.md) tutorial first!</span>
<span class="tip-text">💡 Tip: If this is your first time using Witness, you might benefit from trying the <a href="./getting-started.md">Getting Started</a> tutorial first!</span>

## Intro
This quick tutorial will walk you through a simple example of how Witness can be used. To complete it
Expand Down
6 changes: 3 additions & 3 deletions docs/tutorials/getting-started.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,14 +15,14 @@ You will also of course need to have witness installed, which can be achieved by

### 1. Create a Keypair

><span style={{fontSize:'0.9em'}}>💡 Tip: Witness supports keyless signing with [SPIRE](https://spiffe.io/)!</span>
><span class="tip-text">💡 Tip: Witness supports keyless signing with [SPIRE](https://spiffe.io/)!</span>
```
openssl genpkey -algorithm ed25519 -outform PEM -out testkey.pem
openssl pkey -in testkey.pem -pubout > testpub.pem
```

### 2. Create a Witness Configuration
><span style={{fontSize: '0.9em'}}>💡 Tip: Witness supports creating attestations for a wide variety of services,
><span class="tip-text">💡 Tip: Witness supports creating attestations for a wide variety of services,
> including Github Actions </span>
- This file generally resides in your source code repository along with the public keys generated above.
Expand All @@ -44,7 +44,7 @@ verify:
```

### 3. Record attestations for a build step
><span style={{fontSize: '0.9em'}}>💡 Tip: You can upload the recorded attestations to an [Archivista](https://github.com/in-toto/archivista) server by using the `--enable-archivista` flag!</span>
><span class="tip-text">💡 Tip: You can upload the recorded attestations to an [Archivista](https://github.com/in-toto/archivista) server by using the `--enable-archivista` flag!</span>
- The `-a {attestor}` flag allows you to define which attestors run
- ex. `-a maven -a gcp -a gitlab` would be used for a maven build running on a GitLab runner on GCP.
- Defining step names is important, these will be used in the policy.
Expand Down
2 changes: 1 addition & 1 deletion docs/tutorials/sigstore-keyless.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Signing Attestations with Sigstore Keyless

><span style={{fontSize: '0.9em'}}>💡 Tip: If this is your first time using Witness, you might benefit from trying the [Getting Started](./getting-started.md) tutorial first! You might
><span class="tip-text">💡 Tip: If this is your first time using Witness, you might benefit from trying the [Getting Started](./getting-started.md) tutorial first! You might
also benefit from trying the [Witness Policy](./artifact-policy.md) tutorial, as it gives key insight into how to create more simple policies.</span>
## Intro
Expand Down
20 changes: 0 additions & 20 deletions docs/witness.md

This file was deleted.

5 changes: 5 additions & 0 deletions witness-website/src/css/custom.css
Original file line number Diff line number Diff line change
Expand Up @@ -87,3 +87,8 @@
width: 30px;
}

.tip-text {
font-size: 0.9em;
/* Add any other styles you need for the tip text */
}

0 comments on commit af4cc5b

Please sign in to comment.