Skip to content

Commit

Permalink
adding docs website source
Browse files Browse the repository at this point in the history
Signed-off-by: chaosinthecrd <[email protected]>
  • Loading branch information
ChaosInTheCRD committed Feb 20, 2024
1 parent 2a83684 commit ecfe115
Show file tree
Hide file tree
Showing 60 changed files with 40,229 additions and 1 deletion.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
<center>

**[DOCS](https://witness.dev)
[CONTRIBUTING](../CONTRIBUTING.md)
[CONTRIBUTING](/CONTRIBUTING.md)
[LICENSE](../LICENSE)**

`bash <(curl -s https://raw.githubusercontent.com/in-toto/witness/main/install-witness.sh)`
Expand Down
5 changes: 5 additions & 0 deletions docs-website/.docusaurus/DONT-EDIT-THIS-FOLDER
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
This folder stores temp files that Docusaurus' client bundler accesses.

DO NOT hand-modify files in this folder because they will be overwritten in the
next build. You can clear all build artifacts (including this folder) with the
`docusaurus clear` command.
6 changes: 6 additions & 0 deletions docs-website/.docusaurus/client-modules.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
export default [
require("/Users/chaosinthecrd/Git/witness-project/witness/docs-website/node_modules/infima/dist/css/default/default.css"),
require("/Users/chaosinthecrd/Git/witness-project/witness/docs-website/node_modules/@docusaurus/theme-classic/lib/prism-include-languages"),
require("/Users/chaosinthecrd/Git/witness-project/witness/docs-website/node_modules/@docusaurus/theme-classic/lib/nprogress"),
require("/Users/chaosinthecrd/Git/witness-project/witness/docs-website/src/css/custom.css"),
];
1 change: 1 addition & 0 deletions docs-website/.docusaurus/codeTranslations.json
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
{}
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
{
"name": "docusaurus-plugin-content-docs",
"id": "default"
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
{
"id": "CODE_OF_CONDUCT",
"title": "Contributor Covenant Code of Conduct",
"description": "Our Pledge",
"source": "@site/../CODE_OF_CONDUCT.md",
"sourceDirName": ".",
"slug": "/CODE_OF_CONDUCT",
"permalink": "/docs/CODE_OF_CONDUCT",
"draft": false,
"unlisted": false,
"tags": [],
"version": "current",
"frontMatter": {},
"sidebar": "docsSidebar",
"previous": {
"title": "Contributing to Witness",
"permalink": "/docs/CONTRIBUTING"
}
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
{
"id": "CONTRIBUTING",
"title": "Contributing to Witness",
"description": "We welcome contributions from the community and first want to thank you for",
"source": "@site/../CONTRIBUTING.md",
"sourceDirName": ".",
"slug": "/CONTRIBUTING",
"permalink": "/docs/CONTRIBUTING",
"draft": false,
"unlisted": false,
"tags": [],
"version": "current",
"frontMatter": {},
"sidebar": "docsSidebar",
"previous": {
"title": "Witness CLI Reference",
"permalink": "/docs/docs/commands"
},
"next": {
"title": "Contributor Covenant Code of Conduct",
"permalink": "/docs/CODE_OF_CONDUCT"
}
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
{
"id": "docs/about/how-witness-works",
"title": "How Witness Works",
"description": "Signing",
"source": "@site/../docs/about/how-witness-works.md",
"sourceDirName": "docs/about",
"slug": "/docs/about/how-witness-works",
"permalink": "/docs/docs/about/how-witness-works",
"draft": false,
"unlisted": false,
"tags": [],
"version": "current",
"frontMatter": {}
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
{
"id": "docs/attestors/aws-iid",
"title": "AWS Instance Identity Attestor",
"description": "The AWS (Amazon Web Services) Instance Identity Attestor communicates with the AWS Instance Metadata to collect",
"source": "@site/../docs/attestors/aws-iid.md",
"sourceDirName": "docs/attestors",
"slug": "/docs/attestors/aws-iid",
"permalink": "/docs/docs/attestors/aws-iid",
"draft": false,
"unlisted": false,
"tags": [],
"version": "current",
"frontMatter": {},
"sidebar": "docsSidebar",
"previous": {
"title": "Policies",
"permalink": "/docs/docs/concepts/policy"
},
"next": {
"title": "Command Attestor",
"permalink": "/docs/docs/attestors/commandrun"
}
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
{
"id": "docs/attestors/commandrun",
"title": "Command Attestor",
"description": "The Command Attestor collects information about a command that TestifySec Witness executes and observes.",
"source": "@site/../docs/attestors/commandrun.md",
"sourceDirName": "docs/attestors",
"slug": "/docs/attestors/commandrun",
"permalink": "/docs/docs/attestors/commandrun",
"draft": false,
"unlisted": false,
"tags": [],
"version": "current",
"frontMatter": {},
"sidebar": "docsSidebar",
"previous": {
"title": "AWS Instance Identity Attestor",
"permalink": "/docs/docs/attestors/aws-iid"
},
"next": {
"title": "Environment Attestor",
"permalink": "/docs/docs/attestors/environment"
}
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
{
"id": "docs/attestors/environment",
"title": "Environment Attestor",
"description": "The Environment Attestor records the OS, hostname, username, and all environment variables set",
"source": "@site/../docs/attestors/environment.md",
"sourceDirName": "docs/attestors",
"slug": "/docs/attestors/environment",
"permalink": "/docs/docs/attestors/environment",
"draft": false,
"unlisted": false,
"tags": [],
"version": "current",
"frontMatter": {},
"sidebar": "docsSidebar",
"previous": {
"title": "Command Attestor",
"permalink": "/docs/docs/attestors/commandrun"
},
"next": {
"title": "GCP Instance Identity Attestor",
"permalink": "/docs/docs/attestors/gcp-iit"
}
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
{
"id": "docs/attestors/gcp-iit",
"title": "GCP Instance Identity Attestor",
"description": "The Google Cloud Platform (GCP) Instance Identity Attestor communicates with the GCP metadata server to collect information",
"source": "@site/../docs/attestors/gcp-iit.md",
"sourceDirName": "docs/attestors",
"slug": "/docs/attestors/gcp-iit",
"permalink": "/docs/docs/attestors/gcp-iit",
"draft": false,
"unlisted": false,
"tags": [],
"version": "current",
"frontMatter": {},
"sidebar": "docsSidebar",
"previous": {
"title": "Environment Attestor",
"permalink": "/docs/docs/attestors/environment"
},
"next": {
"title": "Git Attestor",
"permalink": "/docs/docs/attestors/git"
}
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
{
"id": "docs/attestors/git",
"title": "Git Attestor",
"description": "The Git Attestor records the current state of the objects in the git repository, including untracked objects.",
"source": "@site/../docs/attestors/git.md",
"sourceDirName": "docs/attestors",
"slug": "/docs/attestors/git",
"permalink": "/docs/docs/attestors/git",
"draft": false,
"unlisted": false,
"tags": [],
"version": "current",
"frontMatter": {},
"sidebar": "docsSidebar",
"previous": {
"title": "GCP Instance Identity Attestor",
"permalink": "/docs/docs/attestors/gcp-iit"
},
"next": {
"title": "GitLab Attestor",
"permalink": "/docs/docs/attestors/gitlab"
}
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
{
"id": "docs/attestors/gitlab",
"title": "GitLab Attestor",
"description": "The GitLab Attestor records information about the GitLab CI/CD job execution in which",
"source": "@site/../docs/attestors/gitlab.md",
"sourceDirName": "docs/attestors",
"slug": "/docs/attestors/gitlab",
"permalink": "/docs/docs/attestors/gitlab",
"draft": false,
"unlisted": false,
"tags": [],
"version": "current",
"frontMatter": {},
"sidebar": "docsSidebar",
"previous": {
"title": "Git Attestor",
"permalink": "/docs/docs/attestors/git"
},
"next": {
"title": "JWT Attestor",
"permalink": "/docs/docs/attestors/jwt"
}
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
{
"id": "docs/attestors/jwt",
"title": "JWT Attestor",
"description": "The JWT (JSON Web Token) Attestor verifies a JWT against a JWKS (JSON Web Key Set) and records information about the",
"source": "@site/../docs/attestors/jwt.md",
"sourceDirName": "docs/attestors",
"slug": "/docs/attestors/jwt",
"permalink": "/docs/docs/attestors/jwt",
"draft": false,
"unlisted": false,
"tags": [],
"version": "current",
"frontMatter": {},
"sidebar": "docsSidebar",
"previous": {
"title": "GitLab Attestor",
"permalink": "/docs/docs/attestors/gitlab"
},
"next": {
"title": "Material Attestor",
"permalink": "/docs/docs/attestors/material"
}
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
{
"id": "docs/attestors/material",
"title": "Material Attestor",
"description": "The Material Attestor records the digests of all files in the working directory of TestifySec Witness",
"source": "@site/../docs/attestors/material.md",
"sourceDirName": "docs/attestors",
"slug": "/docs/attestors/material",
"permalink": "/docs/docs/attestors/material",
"draft": false,
"unlisted": false,
"tags": [],
"version": "current",
"frontMatter": {},
"sidebar": "docsSidebar",
"previous": {
"title": "JWT Attestor",
"permalink": "/docs/docs/attestors/jwt"
},
"next": {
"title": "Maven Attestor",
"permalink": "/docs/docs/attestors/maven"
}
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
{
"id": "docs/attestors/maven",
"title": "Maven Attestor",
"description": "The Maven Attestor records project and dependency information from a provided pom.xml (Maven Project Object Model).",
"source": "@site/../docs/attestors/maven.md",
"sourceDirName": "docs/attestors",
"slug": "/docs/attestors/maven",
"permalink": "/docs/docs/attestors/maven",
"draft": false,
"unlisted": false,
"tags": [],
"version": "current",
"frontMatter": {},
"sidebar": "docsSidebar",
"previous": {
"title": "Material Attestor",
"permalink": "/docs/docs/attestors/material"
},
"next": {
"title": "OCI Attestor",
"permalink": "/docs/docs/attestors/oci"
}
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
{
"id": "docs/attestors/oci",
"title": "OCI Attestor",
"description": "The OCI Attestor records information about a provided Open Container Initiative (OCI) image stored on disk as a tarball.",
"source": "@site/../docs/attestors/oci.md",
"sourceDirName": "docs/attestors",
"slug": "/docs/attestors/oci",
"permalink": "/docs/docs/attestors/oci",
"draft": false,
"unlisted": false,
"tags": [],
"version": "current",
"frontMatter": {},
"sidebar": "docsSidebar",
"previous": {
"title": "Maven Attestor",
"permalink": "/docs/docs/attestors/maven"
},
"next": {
"title": "Product Attestor",
"permalink": "/docs/docs/attestors/product"
}
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
{
"id": "docs/attestors/product",
"title": "Product Attestor",
"description": "The Product Attestor examines materials recorded before a command was run and records all",
"source": "@site/../docs/attestors/product.md",
"sourceDirName": "docs/attestors",
"slug": "/docs/attestors/product",
"permalink": "/docs/docs/attestors/product",
"draft": false,
"unlisted": false,
"tags": [],
"version": "current",
"frontMatter": {},
"sidebar": "docsSidebar",
"previous": {
"title": "OCI Attestor",
"permalink": "/docs/docs/attestors/oci"
},
"next": {
"title": "Witness CLI Reference",
"permalink": "/docs/docs/commands"
}
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
{
"id": "docs/commands",
"title": "Witness CLI Reference",
"description": "This is the reference for the Witness command line tool, generated by Cobra.",
"source": "@site/../docs/commands.md",
"sourceDirName": "docs",
"slug": "/docs/commands",
"permalink": "/docs/docs/commands",
"draft": false,
"unlisted": false,
"tags": [],
"version": "current",
"frontMatter": {},
"sidebar": "docsSidebar",
"previous": {
"title": "Product Attestor",
"permalink": "/docs/docs/attestors/product"
},
"next": {
"title": "Contributing to Witness",
"permalink": "/docs/CONTRIBUTING"
}
}
Loading

0 comments on commit ecfe115

Please sign in to comment.