chore(docs): migrate Chainloop docs to the main repo (#568)

Signed-off-by: Daniel Liszka <[email protected]>

Author: danlishka

.github/workflows/contracts/docs.yml

@@ -0,0 +1,13 @@
+# Chainloop workflow associated with .github/workflows/deploy.yml
+# https://docs.chainloop.dev/reference/operator/contract
+schemaVersion: v1
+materials:
+  - type: ARTIFACT
+    name: built-site
+    output: true
+  - type: SBOM_CYCLONEDX_JSON
+    name: sbom-cdx
+  - type: SBOM_SPDX_JSON
+    name: sbom-spdx
+runner:
+  type: GITHUB_ACTION

.github/workflows/docs_deploy.yml

@@ -0,0 +1,59 @@
+name: Deploy Documentation
+
+on:
+  push:
+    tags: ['v*.*.*']
+  workflow_dispatch:
+
+# Limit to a single workflow
+concurrency: "deploy-to-prod"
+
+jobs:
+  deploy_docs:
+    name: Deploy Documentation
+    runs-on: ubuntu-latest
+    defaults:
+      run:
+        working-directory: ./docs
+    steps:
+      - uses: actions/checkout@v3
+        with:
+          sparse-checkout: |
+            docs
+          sparse-checkout-cone-mode: false
+
+      - name: Install Syft
+        run: |
+          # Install Syft
+          wget --no-verbose https://raw.githubusercontent.com/anchore/syft/main/install.sh -O - | sh -s -- -b /usr/local/bin
+
+      - uses: actions/setup-node@v3
+        with:
+          node-version: 18
+
+      - name: yarn install
+        run: yarn install
+
+      - name: Build
+        run: netlify build
+
+      - name: Deploy
+        run: netlify deploy --prod
+
+      - name: Generate reports
+        run: |
+          mkdir -p reports
+          syft packages . -o cyclonedx-json --file reports/sbom.cyclonedx.json
+          syft packages . -o spdx-json --file reports/sbom.spdx.json
+          tar -czf reports/build.tar.gz build
+  
+      # Upload artifacts so they are shared with the chainloop job
+      - uses: actions/upload-artifact@a8a3f3ad30e3422c9c7b888a15615d19a852ae32 # v3.1.3
+        with:
+          name: reports
+          path: docs/reports/*
+
+    env:
+      GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+      NETLIFY_AUTH_TOKEN: ${{ secrets.NETLIFY_AUTH_TOKEN }}
+      NETLIFY_SITE_ID: ${{ secrets.NETLIFY_SITE_ID }}

.github/workflows/docs_test.yml

@@ -0,0 +1,26 @@
+name: Documentation Build and Test
+on:
+  pull_request:
+    paths: ['docs/**']
+  push:
+    branches: ['main']
+    paths: ['docs/**']
+jobs:
+  docs_build_and_test:
+    name: Documentation Build and Test
+    runs-on: ubuntu-latest
+    defaults:
+      run:
+        working-directory: ./docs
+    steps:
+      - uses: actions/checkout@v3
+        with:
+          sparse-checkout: |
+            docs
+          sparse-checkout-cone-mode: false
+      - uses: actions/setup-node@v3
+        with:
+          node-version: 18
+      - name: yarn install & build
+        run: yarn install && yarn build
+

README.md

@@ -30,25 +30,25 @@ See the [getting started guide](https://docs.chainloop.dev/getting-started/insta
 To **install the latest version** for macOS, Linux or Windows (using [WSL](https://learn.microsoft.com/en-us/windows/wsl/install)) just choose one of the following installation methods.
 
 ```bash
-curl -sfL https://raw.githubusercontent.com/chainloop-dev/docs/main/static/install.sh | bash -s
+curl -sfL https://raw.githubusercontent.com/chainloop-dev/chainloop/main/docs/static/install.sh | bash -s
 ```
 
 you can retrieve a specific version with
 
 ```bash
-curl -sfL https://raw.githubusercontent.com/chainloop-dev/docs/main/static/install.sh | bash -s -- --version v0.8.95
+curl -sfL https://raw.githubusercontent.com/chainloop-dev/chainloop/main/docs/static/install.sh | bash -s -- --version v0.8.95
 ```
 
 and customize the install path (default to /usr/local/bin)
 
 ```bash
-curl -sfL https://raw.githubusercontent.com/chainloop-dev/docs/main/static/install.sh | bash -s -- --path /my-path
+curl -sfL https://raw.githubusercontent.com/chainloop-dev/chainloop/main/docs/static/install.sh | bash -s -- --path /my-path
 ```
 
 if [`cosign`](https://docs.sigstore.dev/cosign) is present in your system, in addition to the checksum check, a signature verification will be performed. This behavior can be enforced via the `--force-verification` flag.
 
 ```bash
-curl -sfL https://raw.githubusercontent.com/chainloop-dev/docs/main/static/install.sh | bash -s -- --force-verification
+curl -sfL https://raw.githubusercontent.com/chainloop-dev/chainloop/main/docs/static/install.sh | bash -s -- --force-verification
 ```
 
 ### Deploy Chainloop (optional)
@@ -109,7 +109,7 @@ Operators can set up third-party integrations such as [Dependency-Track](https:/
 
 Ops can mix and match with different integrations while **not requiring developers to make any changes on their side**!
 
-To learn more and to find the list of available integrations, check our [integrations page](./docs/integrations.md).
+To learn more and to find the list of available integrations, check our [integrations page](./devel/integrations.md).
 
 ### Role-tailored experience
 

app/controlplane/plugins/sdk/readme-generator/main.go

@@ -13,7 +13,7 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 
-//go:generate go run main.go --dir ../../core --integrations-index-path ../../../../../docs/integrations.md
+//go:generate go run main.go --dir ../../core --integrations-index-path ../../../../../devel/integrations.md
 
 package main
 
@@ -162,7 +162,7 @@ func main() {
 
 func init() {
 	flag.StringVar(&pluginsDir, "dir", "", "base directory for plugins i.e ./core")
-	flag.StringVar(&integrationsIndexPath, "integrations-index-path", "", "integrations list markdown file i.e docs/integrations.md")
+	flag.StringVar(&integrationsIndexPath, "integrations-index-path", "", "integrations list markdown file i.e devel/integrations.md")
 	flag.Parse()
 }
 

docs/integrations.md devel/integrations.mddocs/integrations.md renamed to devel/integrations.md

@@ -0,0 +1,24 @@
+# Dependencies
+/node_modules
+
+# Production
+/build
+
+# Generated files
+.docusaurus
+.cache-loader
+
+# Misc
+.DS_Store
+.env.local
+.env.development.local
+.env.test.local
+.env.production.local
+
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+
+.vscode
+# Local Netlify folder
+.netlify

docs/.gitignore

@@ -0,0 +1 @@
+### Source code for [docs.chainloop.dev](https://docs.chainloop.dev) built using [Docusaurus](https://docusaurus.io/)

docs/README.md

@@ -0,0 +1,3 @@
+module.exports = {
+  presets: [require.resolve('@docusaurus/core/lib/babel/preset')],
+};

docs/babel.config.js

@@ -0,0 +1,43 @@
+---
+sidebar_position: 7
+---
+
+# Beta Testers
+
+:::caution
+Chainloop is under active development, please don't use it as part of your critical infrastructure until it reaches the 1.0 release.
+:::
+
+First of all, **thank you for trying out Chainloop**! Although we are in the early stages, we are hungry for feedback so **your contribution as an early user is invaluable**.
+
+If you have chosen to giving Chainloop a try, this page is for you. It will contain tips, caveats and other pieces of information related to the beta testing process.
+
+### CLI graceful exit
+
+Although Chainloop is under active development, we want you to try it out and integrate it into your CI/CD systems safely.
+
+That's why the `attestation` subcommand will **by default exit 0** in the case of an error. This option will make sure that your CI/CD pipelines will keep working during potential transient errors.
+
+If you feel adventurous and want to make sure that the attestation process is finished correctly, you can override this behavior by setting the flag `--graceful-exit=false`
+
+```bash
+$ chainloop att
+Usage:
+  chainloop attestation [command]
+
+Aliases:
+  attestation, att
+
+Available Commands:
+  ...
+
+Flags:
+      # highlight-next-line
+      --graceful-exit   exit 0 in case of error. NOTE: this behavior will change once 1.0 is reached (default true)
+```
+
+### Contact/Feedback
+
+We would love to hear from you, any thoughts, requests, issues your encountered, or even compliments :)
+
+Please send those our way through [this contact form](https://chainloop.dev/contact) or [email](mailto:[email protected]).