docs: add website for user documentation

.github/workflows/publish_docs.yml

@@ -0,0 +1,36 @@
+name: publish docs to GitHub Pages
+
+on:
+  push:
+    branches:
+      - main
+    paths:
+      - docs/**
+
+permissions:
+  contents: write
+
+jobs:
+  deploy:
+    name: Publish docs to GitHub Pages
+    runs-on: ubuntu-22.04
+    steps:
+      - uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11 # v4.1.1
+      - uses: actions/setup-node@60edb5dd545a775178f52524783378180af0d1f8 # v4.0.2
+        with:
+          node-version: 18
+          cache: npm
+          cache-dependency-path: ./docs
+      - name: Install dependencies
+        working-directory: ./docs
+        run: npm ci
+      - name: Build website
+        working-directory: ./docs
+        run: npm run build
+      - name: Deploy to GitHub Pages
+        uses: peaceiris/actions-gh-pages@373f7f263a76c20808c831209c920827a82a2847 # v3.9.3
+        with:
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+          publish_dir: ./docs/build # Build output to publish to the `gh-pages` branch
+          user_name: edgelessci
+          user_email: [email protected]

.gitignore

@@ -10,3 +10,6 @@ workspace
 workspace.cache
 .direnv/
 go.work.sum
+node_modules
+.docusaurus
+build/

docs/.envrc

@@ -0,0 +1 @@
+use flake ..#docs

docs/README.md

@@ -0,0 +1,30 @@
+# Contrast Documentation
+
+## Previewing
+
+During edits you can preview your changes using the [`docusaurus`](https://docusaurus.io/docs/installation):
+
+```sh
+# requires node >=16.14
+npm run start
+```
+
+Browse to <http://localhost:3000/contrast> and choose the "Next" version in the top right.
+
+## Publish process
+
+The docs are updated with [publish-docs](../.github/workflows/publish-docs.yml) when pushed on main.
+
+## Release process
+
+1. [Tagging a new version](https://docusaurus.io/docs/next/versioning#tagging-a-new-version)
+
+    ```shell
+    npm run docusaurus docs:version X.X
+    ```
+
+    When tagging a new version, the document versioning mechanism will:
+
+    Copy the full `docs/docs/` folder contents into a new `docs/versioned_docs/version-[versionName]/` folder.
+    Create a versioned sidebars file based from your current sidebar configuration (if it exists) - saved as `docs/versioned_sidebars/version-[versionName]-sidebars.json`.
+    Append the new version number to `versions.json`.

docs/babel.config.js

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

docs/docs/intro.md

@@ -0,0 +1,9 @@
+---
+slug: /
+id: intro
+---
+# Introduction
+
+Contrast runs confidential container deployments on untrusted Kubernetes at scale.
+
+Contrast is based on the Kata Containers and Confidential Containers projects. Confidential Containers are Kubernetes pods that are executed inside a confidential micro-VM and provide strong hardware-based isolation from the surrounding environment. This works with unmodified containers in a lift-and-shift approach. It currently targets the CoCo preview on AKS.

docs/docusaurus.config.js

@@ -0,0 +1,274 @@
+// @ts-check
+// Note: type annotations allow type checking and IDEs autocompletion
+
+const lightCodeTheme = require('prism-react-renderer').themes.github;
+const darkCodeTheme = require('prism-react-renderer').themes.dracula;
+
+/** @type {import('@docusaurus/types').Config} */
+async function createConfig() {
+  return {
+    title: 'Contrast',
+    tagline: 'Contrast: Confidential Containers at scale',
+    url: 'https://docs.edgeless.systems',
+    baseUrl: '/contrast/',
+    onBrokenLinks: 'throw',
+    onBrokenMarkdownLinks: 'throw',
+    favicon: 'img/favicon.ico',
+
+    // GitHub pages deployment config.
+    // If you aren't using GitHub pages, you don't need these.
+    organizationName: 'edgelesssys', // Usually your GitHub org/user name.
+    projectName: 'contrast', // Usually your repo name.
+    deploymentBranch: 'gh-pages',
+
+    // scripts
+    scripts: [
+      { id: "Cookiebot", src: "https://consent.cookiebot.com/uc.js", "data-cbid": "a0cc864f-0b67-49be-8d65-9ed354de2ee6", "data-blockingmode": "auto" },
+      { id: "CookieDeclaration", src: "https://consent.cookiebot.com/a0cc864f-0b67-49be-8d65-9ed354de2ee6/cd.js" }
+    ],
+
+    // Even if you don't use internalization, you can use this field to set useful
+    // metadata like html lang. For example, if your site is Chinese, you may want
+    // to replace "en" with "zh-Hans".
+    i18n: {
+      defaultLocale: 'en',
+      locales: ['en'],
+    },
+
+    // mermaid
+    markdown: {
+      mermaid: true,
+    },
+    themes: ['@docusaurus/theme-mermaid'],
+
+    presets: [
+      [
+        'classic',
+        /** @type {import('@docusaurus/preset-classic').Options} */
+        ({
+          docs: {
+            sidebarPath: require.resolve('./sidebars.js'),
+            // sidebarPath: 'sidebars.js',
+            // Please change this to your repo.
+            // Remove this to remove the "edit this page" links.
+            //editUrl: 'https://github.com/edgelesssys/contrast/edit/main/docs',
+            routeBasePath: "/"
+          },
+          blog: false,
+          theme: {
+            customCss: require.resolve('./src/css/custom.css'),
+          },
+          gtag: {
+            trackingID: 'G-3DVYB2CHLG',
+            anonymizeIP: true,
+          }
+        }),
+      ],
+    ],
+
+    themeConfig:
+      /** @type {import('@docusaurus/preset-classic').ThemeConfig} */
+      ({
+        navbar: {
+          hideOnScroll: false,
+          logo: {
+            alt: 'Contrast Logo',
+            src: 'img/logos/contrast_icon.svg',
+          },
+          items: [
+            // left
+            // Running docs only mode no need for a link here
+            // {
+            //   type: 'doc',
+            //   docId: 'intro',
+            //   position: 'left',
+            //   label: 'Docs',
+            // },
+            // right
+            {
+              type: 'docsVersionDropdown',
+              position: 'right',
+            },
+            //{
+            //  href: 'https://github.com/edgelesssys/constellation',
+            //  position: 'right',
+            //  className: 'header-github-link',
+            //},
+          ],
+        },
+        colorMode: {
+          defaultMode: 'light',
+          disableSwitch: true,
+          respectPrefersColorScheme: false,
+        },
+        //announcementBar: {
+        //  content:
+        //    'If you like Constellation, give it a star on <a target="_blank" rel="noopener noreferrer" href="https://github.com/edgelesssys/constellation">GitHub</a> ⭐️',
+        //  backgroundColor: '#E7E6E6'
+        //},
+        footer: {
+          style: 'dark',
+          links: [
+            {
+              title: 'Community',
+              items: [
+                {
+                  label: 'Newsletter',
+                  href: 'https://www.edgeless.systems/#footer'
+                },
+              ],
+            },
+            {
+              title: 'Social',
+              items: [
+                {
+                  label: 'Blog',
+                  href: 'https://www.edgeless.systems/blog/',
+                },
+                {
+                  label: 'Twitter',
+                  href: 'https://twitter.com/EdgelessSystems',
+                },
+                {
+                  label: 'LinkedIn',
+                  href: 'https://www.linkedin.com/company/edgeless-systems/',
+                },
+
+                {
+                  label: 'Youtube',
+                  href: 'https://www.youtube.com/channel/UCOOInN0sCv6icUesisYIDeA',
+                },
+              ],
+            },
+            {
+              title: 'Company',
+              items: [
+                {
+                  label: 'Imprint',
+                  href: 'https://www.edgeless.systems/imprint/',
+                },
+                {
+                  label: 'Privacy Policy',
+                  href: 'https://www.edgeless.systems/privacy/',
+                },
+                {
+                  html: `<a href="javascript: Cookiebot.renew()" class="footer__link-item">Cookie Settings</a>`
+                },
+
+                {
+                  label: 'Contact Us',
+                  href: 'https://www.edgeless.systems/contact-us/',
+                },
+              ],
+            },
+          ],
+          copyright: `Copyright © ${new Date().getFullYear()} Edgeless Systems`,
+        },
+        prism: {
+          theme: lightCodeTheme,
+          darkTheme: darkCodeTheme,
+          additionalLanguages: ['shell-session'],
+        },
+        mermaid: {
+          theme: { light: 'base', dark: 'base' },
+          options: {
+            themeVariables: {
+              // general
+              fontFamily: '"Open Sans", sans-serif',
+              primaryColor: '#90FF99', // edgeless green
+              primaryTextColor: '#000000',
+              secondaryColor: '#A5A5A5', // edgeless grey
+              secondaryTextColor: '#000000',
+              tertiaryColor: '#E7E6E6', // edgeless light grey
+              tertiaryTextColor: '#000000',
+              // flowchart
+              clusterBorder: '#A5A5A5',
+              clusterBkg: '#ffffff',
+              edgeLabelBackground: '#ffffff',
+              // sequence diagram
+              activationBorderColor: '#000000',
+              actorBorder: '#A5A5A5',
+              actorFontFamily: '"Open Sans", sans-serif', // not released by mermaid yet
+              noteBkgColor: '#8B04DD', // edgeless purple
+              noteTextColor: '#ffffff',
+            },
+            startOnLoad: true,
+          },
+        },
+      }),
+
+    plugins: [
+      [
+        require.resolve("@cmfcmf/docusaurus-search-local"),
+        {
+          // whether to index docs pages
+          indexDocs: true,
+
+          // Whether to also index the titles of the parent categories in the sidebar of a doc page.
+          // 0 disables this feature.
+          // 1 indexes the direct parent category in the sidebar of a doc page
+          // 2 indexes up to two nested parent categories of a doc page
+          // 3...
+          //
+          // Do _not_ use Infinity, the value must be a JSON-serializable integer.
+          indexDocSidebarParentCategories: 0,
+
+          // whether to index blog pages
+          indexBlog: false,
+
+          // whether to index static pages
+          // /404.html is never indexed
+          indexPages: false,
+
+          // language of your documentation, see next section
+          language: "en",
+
+          // setting this to "none" will prevent the default CSS to be included. The default CSS
+          // comes from autocomplete-theme-classic, which you can read more about here:
+          // https://www.algolia.com/doc/ui-libraries/autocomplete/api-reference/autocomplete-theme-classic/
+          // When you want to overwrite CSS variables defined by the default theme, make sure to suffix your
+          // overwrites with `!important`, because they might otherwise not be applied as expected. See the
+          // following comment for more information: https://github.com/cmfcmf/docusaurus-search-local/issues/107#issuecomment-1119831938.
+          style: undefined,
+
+          // The maximum number of search results shown to the user. This does _not_ affect performance of
+          // searches, but simply does not display additional search results that have been found.
+          maxSearchResults: 8,
+
+          // lunr.js-specific settings
+          lunr: {
+            // When indexing your documents, their content is split into "tokens".
+            // Text entered into the search box is also tokenized.
+            // This setting configures the separator used to determine where to split the text into tokens.
+            // By default, it splits the text at whitespace and dashes.
+            //
+            // Note: Does not work for "ja" and "th" languages, since these use a different tokenizer.
+            tokenizerSeparator: /[\s\-]+/,
+            // https://lunrjs.com/guides/customising.html#similarity-tuning
+            //
+            // This parameter controls the importance given to the length of a document and its fields. This
+            // value must be between 0 and 1, and by default it has a value of 0.75. Reducing this value
+            // reduces the effect of different length documents on a term’s importance to that document.
+            b: 0.75,
+            // This controls how quickly the boost given by a common word reaches saturation. Increasing it
+            // will slow down the rate of saturation and lower values result in quicker saturation. The
+            // default value is 1.2. If the collection of documents being indexed have high occurrences
+            // of words that are not covered by a stop word filter, these words can quickly dominate any
+            // similarity calculation. In these cases, this value can be reduced to get more balanced results.
+            k1: 1.2,
+            // By default, we rank pages where the search term appears in the title higher than pages where
+            // the search term appears in just the text. This is done by "boosting" title matches with a
+            // higher value than content matches. The concrete boosting behavior can be controlled by changing
+            // the following settings.
+            titleBoost: 5,
+            contentBoost: 1,
+            tagsBoost: 3,
+            parentCategoriesBoost: 2, // Only used when indexDocSidebarParentCategories > 0
+          }
+        },
+      ]
+    ]
+  }
+};
+
+module.exports = createConfig;