Skip to content

Commit 31eac55

Browse files
authored
docs: update docs references and remove old code (#1998)
Signed-off-by: Miguel Martinez <[email protected]>
1 parent 98b2239 commit 31eac55

File tree

139 files changed

+11
-21285
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

139 files changed

+11
-21285
lines changed

.chainloop.yml

-7
Original file line numberDiff line numberDiff line change
@@ -3,13 +3,6 @@ projectVersion: v1.0.0-rc.11
33

44
# Experimental feature used by Chainloop labs shared workflow https://github.com/chainloop-dev/labs
55
# It maps the material names with location in disk so they get automatically attested
6-
docs:
7-
- name: sbom-cdx
8-
path: reports/sbom.cyclonedx.json
9-
- name: sbom-spdx
10-
path: reports/sbom.spdx.json
11-
- name: built-site
12-
path: reports/build.tar.gz
136

147
scorecards:
158
- name: sarif-results

.github/workflows/contracts/chainloop-docs-release.yml

-18
This file was deleted.

.github/workflows/docs_deploy.yml

-89
This file was deleted.

.github/workflows/docs_test.yml

-28
This file was deleted.

README.md

+11-10
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@
1313

1414
[Chainloop](https://github.com/chainloop-dev/chainloop) is an open-source evidence store for your Software Supply Chain attestations, Software Bill of Materials (SBOMs), VEX, SARIF, QA reports, and more. With Chainloop, Security, Compliance, and Risk management teams can define security and compliance policies, what evidence and artifacts they want to receive, and where to store them. On the other hand, developers are shielded from all this complexity by being given simple instructions on what to provide when instrumenting their CI/CD pipelines.
1515

16-
To learn more about the project motivation please look at [our documentation](https://docs.chainloop.dev) and see it in action in [this video](https://www.youtube.com/watch?v=GfSR2ZkZ3as).
16+
To learn more about the project motivation please look at [our documentation](https://docs.chainloop.dev).
1717

1818
## How does it work?
1919

@@ -29,17 +29,17 @@ Chainloop also makes sure the crafting of artifacts and attestation follows **be
2929

3030
### Declarative, contract-based attestation
3131

32-
One key aspect is that in Chainloop, CI/CD integrations are declared via [**Workflow Contracts**](https://docs.chainloop.dev/getting-started/workflow-definition#workflow-contracts).
32+
One key aspect is that in Chainloop, CI/CD integrations are declared via [**Workflow Contracts**](https://docs.chainloop.dev/concepts/contracts).
3333

34-
A [Workflow Contract](https://docs.chainloop.dev/reference/operator/contract) gives Compliance and Security teams **full control over what kind of data (build info, materials) must be received as part of the attestation and the environment where these workflows must be executed at**. This enables an easy, and maintainable, way of propagating and enforcing requirements downstream to your organization.
34+
A Workflow Contract gives Compliance and Security teams **full control over what kind of data (build info, materials) must be received as part of the attestation and the environment where these workflows must be executed at**. This enables an easy, and maintainable, way of propagating and enforcing requirements downstream to your organization.
3535

36-
You can think of it as an [**API for your organization's Software Supply Chain**](https://docs.chainloop.dev/reference/operator/contract) that both parties, development and Compliance and Security teams can use to interact effectively.
36+
You can think of it as an **API for your organization's Software Supply Chain** that both parties, development and Compliance and Security teams can use to interact effectively.
3737

3838
![Chainloop Contracts](./docs/img/overview-3.png)
3939

4040
### Policy as code
4141

42-
Compliance and Security teams can [craft](https://docs.chainloop.dev/guides/rego-policies/) [Rego](https://www.openpolicyagent.org/docs/latest/policy-language/) policies, and [attach](https://docs.chainloop.dev/reference/policies) them to workflow contracts. Those policies will be automatically evaluated, and their results will be added to the attestation before signing and storage.
42+
Compliance and Security teams can [craft](https://docs.chainloop.dev/guides/custom-policies) [Rego](https://www.openpolicyagent.org/docs/latest/policy-language/) policies, and [attach](https://docs.chainloop.dev/concepts/policies) them to workflow contracts. Those policies will be automatically evaluated, and their results will be added to the attestation before signing and storage.
4343

4444

4545
### We meet you where you are with third-party integrations
@@ -58,13 +58,13 @@ Chainloop makes sure to clearly define the responsibilities, experience and func
5858

5959
Compliance and Security teams are the ones in charge of defining the Workflow Contracts, crafting policies, setting up third-party integrations, or having access to the control plane where all the Software Supply Chain Security bells and whistles are exposed.
6060

61-
Development teams on the other hand, just need to integrate Chainloop's jargon-free [crafting tool](https://docs.chainloop.dev/getting-started/attestation-crafting) and follow the steps via a familiar DevExp to make sure they comply with the Workflow Contract defined by the SecOps team. No need to learn in-toto, signing, SLSA, OCI, APIs, nada :)
61+
Development teams on the other hand, just need to integrate Chainloop's jargon-free [crafting tool](https://docs.chainloop.dev/concepts/attestations#attestation-lifecycle) and follow the steps via a familiar DevExp to make sure they comply with the Workflow Contract defined by the SecOps team. No need to learn in-toto, signing, SLSA, OCI, APIs, nada :)
6262

6363
## Supported Pieces of Evidence / Materials
6464

65-
During the attestation process, you can attach different pieces of evidence and artifacts that will get uploaded to the [Content Addressable Storage](https://docs.chainloop.dev/reference/operator/cas-backend/) (if applicable) and referenced in a signed in-toto attestation.
65+
During the attestation process, you can attach different pieces of evidence and artifacts that will get uploaded to the [Content Addressable Storage](https://docs.chainloop.dev/concepts/cas-backend) (if applicable) and referenced in a signed in-toto attestation.
6666

67-
Chainloop supports the collection of the following list of evidence types. For the full list please refer to [this page](https://docs.chainloop.dev/reference/operator/material-types)
67+
Chainloop supports the collection of the following list of evidence types. For the full list please refer to [this page](https://docs.chainloop.dev/concepts/material-types)
6868

6969
- [CycloneDX SBOM](https://github.com/CycloneDX/specification)
7070
- [SPDX SBOM](https://spdx.dev/specifications/)
@@ -82,14 +82,15 @@ Chainloop supports the collection of the following list of evidence types. For t
8282
- [Gitlab Security report](https://docs.gitlab.com/ee/user/application_security/)
8383
- [JUnit](https://www.ibm.com/docs/en/developer-for-zos/14.1?topic=formats-junit-xml-format)
8484
- [JaCoCo XML Coverage Reports](https://www.jacoco.org/jacoco/trunk/doc/)
85+
- [SLSA Provenance files](https://slsa.dev/spec/v1.1/provenance)
8586
- Attestation: existing Chainloop attestations.
8687
- Artifact Type: It represents a software artifact.
8788
- Custom Evidence Type: Custom piece of evidence that doesn't fit in any other category, for instance, an approval report in json format, etc.
8889
- Key-Value metadata pairs
8990

9091
## Getting started
9192

92-
See the [getting started guide](https://docs.chainloop.dev/getting-started/installation#command-line-interface-cli-installation) for detailed information on a) how to download and configure the Chainloop CLI and b) how to deploy Chainloop on your Kubernetes Cluster.
93+
Follow the [quickstart](https://docs.chainloop.dev/quickstart) or the [getting started guide](https://docs.chainloop.dev/get-started) for detailed information on a) how to download and configure the Chainloop CLI and b) how to deploy Chainloop on your Kubernetes Cluster.
9394

9495
### Command Line Interface (CLI) installation
9596

@@ -145,7 +146,7 @@ $ chainloop auth login
145146

146147
### Finishing the setup
147148

148-
Once you've been logged in, follow [these instructions](https://docs.chainloop.dev/getting-started/setup) to learn how to set up your account.
149+
Once you've been logged in, follow [these instructions](https://docs.chainloop.dev/get-started/setup) to learn how to set up your account.
149150
## Documentation
150151

151152
To learn more, please visit the Chainloop project's documentation website, https://docs.chainloop.dev where you will find a getting started guide, FAQ, examples, and more.

docs/.gitignore

-24
This file was deleted.

docs/.syft.yaml

-2
This file was deleted.

docs/README.md

-1
This file was deleted.

docs/babel.config.js

-3
This file was deleted.

docs/docs/beta-testing.md

-43
This file was deleted.

docs/docs/changelog/att-contract.png

-91.5 KB
Binary file not shown.

docs/docs/changelog/att-envelope.png

-52.4 KB
Binary file not shown.

docs/docs/changelog/att-materials.png

-194 KB
Binary file not shown.

docs/docs/changelog/att-statement.png

-147 KB
Binary file not shown.

docs/docs/changelog/changelog.mdx

-15
This file was deleted.
-12.7 KB
Binary file not shown.
-8.22 KB
Binary file not shown.

docs/docs/changelog/metrics.jpeg

-77.2 KB
Binary file not shown.

docs/docs/changelog/pagination.png

-53.9 KB
Binary file not shown.

docs/docs/faq.md

-27
This file was deleted.

docs/docs/getting-started/_category_.json

-7
This file was deleted.

0 commit comments

Comments
 (0)