Skip to content

Commit

Permalink
Merge branch 'main' into specification/logging
Browse files Browse the repository at this point in the history
* main:
  ci(github action): add Markdown linter check support for main branch (#227)
  Redirects now appears in public (#234)
  add 'cosign sign-blob'in the mTLS TSA section (#239)
  Changed 404 text, restored i18n (#238)
  Restored Netlify redirects file (#233)
  Removed docs from URL path (#232)
  Corrected the confusion of steps in the document due to formatting (#220)
  Added anchor text to link to releases page (#223)
  • Loading branch information
normal-coder committed Aug 25, 2023
2 parents 3af5415 + 1b76094 commit 02f1423
Show file tree
Hide file tree
Showing 66 changed files with 359 additions and 242 deletions.
33 changes: 33 additions & 0 deletions .github/workflows/markdownlint.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
name: MarkdownLint

on:
push:
branches:
- main
pull_request:
branches:
- main

jobs:
markdownlint:
runs-on: ubuntu-latest

steps:
- name: Checkout repository
uses: actions/checkout@v3
with:
fetch-depth: 0

- uses: tj-actions/changed-files@v37
id: changed-files
with:
files: '**/*.md'
separator: ","

- uses: DavidAnson/markdownlint-cli2-action@v11
if: steps.changed-files.outputs.any_changed == 'true'
with:
config: '.markdownlint-cli2.jsonc'
globs: ${{ steps.changed-files.outputs.all_changed_files }}
separator: ","
continue-on-error: true
1 change: 1 addition & 0 deletions archetypes/docs.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,4 +12,5 @@ menu:
identifier: "{{ .Name }}-{{ delimit (shuffle (split (md5 .Name) "" )) "" }}"
weight: 999
toc: true
type: docs
---
4 changes: 2 additions & 2 deletions config/_default/params.toml
Original file line number Diff line number Diff line change
Expand Up @@ -93,8 +93,8 @@ lastMod = false
clipBoard = true
instantPage = true
flexSearch = true
searchSectionsShow = []
searchSectionsIndex = []
searchSectionsShow = "ALL"
searchSectionsIndex = "ALL"
darkMode = true
bootStrapJs = true
breadCrumb = true
Expand Down
9 changes: 0 additions & 9 deletions content/en/_index.md

This file was deleted.

Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
---
type: docs
title: "About"
description: "About Sigstore"
lead: ""
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
---
type: docs
category: About sigstore
description: API stability levels and deprecation policy
title: API Stability and Deprecation Policy
Expand Down Expand Up @@ -40,4 +41,4 @@ _Note: These guidelines will be followed on a best-effort basis.
Since Sigstore is a security project, maintainers reserve the right to break things faster if necessary to address a security issue._

A list of features and associated levels will be available in each repository under FEATURES.md.
A deprecation table will be available in each repository under DEPRECATIONS.md.
A deprecation table will be available in each repository under DEPRECATIONS.md.
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
---
type: docs
category: About sigstore
description: Intro text
title: Contributing
Expand Down Expand Up @@ -75,4 +76,4 @@ Docs and other calendar invites may be shared directly with this group, so pleas

## Slack

You can also keep in touch by joining our [Slack channel](https://sigstore.slack.com). Use [this invite link](https://links.sigstore.dev/slack-invite) to join.
You can also keep in touch by joining our [Slack channel](https://sigstore.slack.com). Use [this invite link](https://links.sigstore.dev/slack-invite) to join.
3 changes: 2 additions & 1 deletion content/en/docs/about/faq.md → content/en/about/faq.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
---
type: docs
category: About sigstore
menuTitle: FAQs
title: Frequently asked questions
Expand Down Expand Up @@ -157,4 +158,4 @@ Public blockchains often end up using a centralized entry point for canonicaliza

### Can I get Rekor to work with my X format, framework standard?

- Yes. Using pluggable types you can create your own manifest layout and send it to Rekor. Head over to [pluggable types](/logging/pluggable-types/)
- Yes. Using pluggable types you can create your own manifest layout and send it to Rekor. Head over to [pluggable types](/logging/pluggable-types/)
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
---
type: docs
category: About sigstore
description: Documentation for sigstore
home: true
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
---
type: docs
category: About sigstore
description: ''
title: Research
Expand Down Expand Up @@ -30,4 +31,4 @@ Academic and industry research related to software supply chain security, transp
* [sigstore/java](https://github.com/sigstore/sigstore-java)
* [sigstore/sigstore-maven](https://github.com/sigstore/sigstore-maven)
* [Sigstore Java meeting notes](https://docs.google.com/document/d/1R7mL-IUrc2Z_LuOIvwDWshVuPQS_2VNE_cIQx4Oy5zw/edit)
* Rust: [sigstore/sigstore-rs](https://github.com/sigstore/sigstore-rs)
* Rust: [sigstore/sigstore-rs](https://github.com/sigstore/sigstore-rs)
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
---
type: docs
category: About sigstore
description: ''
title: Security Model
Expand Down Expand Up @@ -78,4 +79,4 @@ Clients like Cosign only need to find the correct Rekor entry to verify the arti

- If an OIDC identity or OIDC provider is compromised, Fulcio might issue unauthorized certificates. However, these certificates are useless unless they are published to the certificate transparency log, so such compromise can be detected.
- If Fulcio is compromised, it might issue unauthorized certificates. However, like before, these should be detectable.
- If no third parties monitor the logs, then any misbehavior by Rekor and Fulcio might go undetected.
- If no third parties monitor the logs, then any misbehavior by Rekor and Fulcio might go undetected.
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
---
type: docs
category: About sigstore
description: ''
title: Get Help
Expand Down Expand Up @@ -29,4 +30,4 @@ Each repository has a `CODEOWNERS` file describing current maintainers. Join our

# Asking questions

We welcome questions! You can either join the [Slack community][sc] and post them on `#general` channel or open a GitHub issue in the relevant repository.
We welcome questions! You can either join the [Slack community][sc] and post them on `#general` channel or open a GitHub issue in the relevant repository.
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
---
type: docs
category: About sigstore
description: ''
title: Threat Model
Expand Down Expand Up @@ -133,4 +134,4 @@ That policy should cover:
* Which Sigstore instance(s) do you trust, and how do you retrieve the key material for those instances?
* How do you handle revocation?

The answers will be different in different settings. For instance, a small organization may be able to meet their security needs by requiring signatures from one fixed party, with a blocklist for revoked artifacts. A large package repository may need to manage signing identities that change frequently over time. We hope to provide more detailed guidance for a variety of settings in future documentation.
The answers will be different in different settings. For instance, a small organization may be able to meet their security needs by requiring signatures from one fixed party, with a blocklist for revoked artifacts. A large package repository may need to manage signing identities that change frequently over time. We hope to provide more detailed guidance for a variety of settings in future documentation.
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
---
type: docs
category: About sigstore
description: ''
features:
Expand Down Expand Up @@ -34,4 +35,4 @@ An identity layer that checks if you're who you say you are. It lets clients req
### Policy Controller

An admission controller for Kubernetes for enforcing policy on
containers allowed to run.
containers allowed to run.
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
---
type: docs
title: "Certificate Authority"
description: "Documentation for Fulcio"
lead: ""
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,8 @@
---
type: docs
category: Certificate authority
title: Transparency Log Info
weight: 1709
---

Review Fulcio's [transparency log information](https://github.com/sigstore/fulcio/blob/main/docs/ctlog.md) on GitHub.
Review Fulcio's [transparency log information](https://github.com/sigstore/fulcio/blob/main/docs/ctlog.md) on GitHub.
Original file line number Diff line number Diff line change
@@ -1,7 +1,8 @@
---
type: docs
category: Certificate authority
title: Certificate Specification
weight: 1725
---

Review Fulcio's [certificate specification](https://github.com/sigstore/fulcio/blob/main/docs/certificate-specification.md) on GitHub.
Review Fulcio's [certificate specification](https://github.com/sigstore/fulcio/blob/main/docs/certificate-specification.md) on GitHub.
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
---
type: docs
category: Certificate authority
menuTitle: Certificate Issuing
title: Certificate Issuing Overview
Expand Down Expand Up @@ -112,4 +113,4 @@ See [Certificate Transparency Log Information](https://github.com/sigstore/fulci

## 7 — Return certificate to client

![Fulcio return the certificate to the client](/fulcio-7-return-to-client.png)
![Fulcio return the certificate to the client](/fulcio-7-return-to-client.png)
Original file line number Diff line number Diff line change
@@ -1,7 +1,8 @@
---
type: docs
category: Certificate authority
title: HSM Support
weight: 1720
---

Review Fulcio's [HSM support](https://github.com/sigstore/fulcio/blob/main/docs/certificate-specification.md) on GitHub.
Review Fulcio's [HSM support](https://github.com/sigstore/fulcio/blob/main/docs/certificate-specification.md) on GitHub.
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
---
type: docs
category: Certificate authority
menuTitle: Using OIDC Tokens
title: OIDC Usage in Fulcio
Expand Down Expand Up @@ -168,4 +169,4 @@ Additionally, the configuration must include `SubjectDomain`, for example `examp

* The issuer in the configuration must partially match the domain in the configuration. The top level domain and second level domain must match. The user who updates the Fulcio configuration must also have control over both the issuer and domain configuration fields (Verified either manually or through an ACME-style challenge).

`SubjectDomain` is appended to `sub` to form an email, `sub@SubjectDomain`, and included as a SAN email address.
`SubjectDomain` is appended to `sub` to form an email, `sub@SubjectDomain`, and included as a SAN email address.
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
---
type: docs
category: Certificate authority
menuTitle: Overview
title: Fulcio
Expand All @@ -13,4 +14,4 @@ Fulcio was designed to run as a centralized, public-good instance, auditable by

Fulcio is being developed as part of the sigstore project. Join us on our [Slack channel](https://sigstore.slack.com/) (need an [invite](https://links.sigstore.dev/slack-invite)?)

You can learn more about Fulcio in the [Fulcio repo](https://github.com/sigstore/fulcio) and the [repo docs](https://github.com/sigstore/fulcio/tree/main/docs).
You can learn more about Fulcio in the [Fulcio repo](https://github.com/sigstore/fulcio) and the [repo docs](https://github.com/sigstore/fulcio/tree/main/docs).
Original file line number Diff line number Diff line change
@@ -1,7 +1,8 @@
---
type: docs
category: Certificate authority
title: Release Log
weight: 1715
---

Review Fulcio's [Release log](https://github.com/sigstore/fulcio/releases) on GitHub.
Review Fulcio's [Release log](https://github.com/sigstore/fulcio/releases) on GitHub.
7 changes: 0 additions & 7 deletions content/en/docs/_index.md

This file was deleted.

Loading

0 comments on commit 02f1423

Please sign in to comment.