Docusaurus documentation site (#426)

* initial docusaurus site architecture

* update node to 14

* change branches

* old branches

* nojekyll and new config

* change branch

* new target branch

* rm tutorial files

* rename intro to index

* trigger ci#

* restore tutorial files

* fix baseurl

* new index

* make site look nice

* clean up tutorial files

* rm index.tsx

* move index.md and switch to docs only mode

* fix image path

* rm push and pull request on ci

* move docs up and rename dir

* add back ci to update site

* fix ci dir

* publish only on release

* Delete .nojekyll

Co-authored-by: Nicolas Ochem <nicolas.ochem@gmail.com>

.github/workflows/docusaurus.yml

@@ -0,0 +1,38 @@
+name: docusaurus
+
+on:
+ release:
+ types: [created]
+
+ # Allows you to run this workflow manually from the Actions tab
+ workflow_dispatch:
+
+# A workflow run is made up of one or more jobs that can run sequentially or in parallel
+jobs:
+ publish-site:
+ runs-on: ubuntu-latest
+ env:
+ REPO_NAME: ${{ github.event.repository.name }}
+ steps:
+ # Checks-out your repository under $GITHUB_WORKSPACE, so your job can access it
+ - name: Check out repo
+ uses: actions/checkout@v3
+ # Node is required for npm
+ - name: Set up Node
+ uses: actions/setup-node@v3
+ with:
+ node-version: "14"
+ # Install and build Docusaurus website
+ - name: Build Docusaurus website
+ run: |
+ cd docs
+ npm install 
+ npm run build
+ - name: Deploy to GitHub Pages
+ if: success()
+ uses: crazy-max/ghaction-github-pages@v2
+ with:
+ target_branch: gh-pages
+ build_dir: docs/build
+ env:
+ GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

docs/.gitignore

@@ -0,0 +1,20 @@
+# 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*

docs/babel.config.js

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

docs/docusaurus.config.js

@@ -0,0 +1,109 @@
+// @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} */
+const config = {
+ title: 'Tezos K8s',
+ tagline: 'Deploy a Tezos Blockchain on Kubernetes',
+ url: 'https://oxheadalpha.com',
+ baseUrl: '/tezos-k8s/',
+ onBrokenLinks: 'throw',
+ onBrokenMarkdownLinks: 'warn',
+ favicon: 'img/favicon.ico',
+ organizationName: 'oxheadalpha', // Usually your GitHub org/user name.
+ projectName: 'tezos-k8', // Usually your repo name.
+
+ presets: [
+ [
+ 'classic',
+ /** @type {import('@docusaurus/preset-classic').Options} */
+ ({
+ docs: {
+ routeBasePath: '/', // Serve the docs at the site's root
+ path: '.',
+ include: ['*.md']
+ },
+ blog: false,
+ theme: {
+ customCss: require.resolve('./src/css/custom.css'),
+ },
+ }),
+ ],
+ ],
+
+ themeConfig:
+ /** @type {import('@docusaurus/preset-classic').ThemeConfig} */
+ ({
+ navbar: {
+ title: 'Home',
+ logo: {
+ alt: 'Oxhead Alpha Logo',
+ src: 'img/logo.svg',
+ },
+ items: [
+ // {
+ // type: 'doc',
+ // docId: 'intro',
+ // position: 'left',
+ // label: 'Tutorial',
+ // },
+ // {to: '/blog', label: 'Blog', position: 'left'},
+ {
+ href: 'https://github.com/oxheadalpha/tezos-k8s',
+ label: 'GitHub',
+ position: 'right',
+ },
+ ],
+ },
+ footer: {
+ style: 'dark',
+ links: [
+ // {
+ // title: 'Docs',
+ // items: [
+ // {
+ // label: 'Tutorial',
+ // to: '/docs/intro',
+ // },
+ // ],
+ // },
+ {
+ title: 'Community',
+ items: [
+ {
+ label: 'Slack',
+ href: 'https://join.slack.com/t/tezos-dev/shared_invite/zt-t1agqhz5-WZfjNoQBg8hcPQSLQn1E2g',
+ },
+ {
+ label: 'Twitter',
+ href: 'https://twitter.com/oxheadalpha',
+ },
+ ],
+ },
+ {
+ title: 'More',
+ items: [
+ {
+ label: 'GitHub',
+ href: 'https://github.com/facebook/docusaurus',
+ },
+ {
+ label: 'Medium',
+ href: 'https://medium.com/the-aleph'
+ }
+ ],
+ },
+ ],
+ copyright: `Copyright © ${new Date().getFullYear()} Oxhead Alpha, Inc.`,
+ },
+ prism: {
+ theme: lightCodeTheme,
+ darkTheme: darkCodeTheme,
+ },
+ }),
+};
+
+module.exports = config;

docs/index.md

@@ -0,0 +1,7 @@
+# Overview
+
+Tezos K8s is a collection of Helm charts and container images that can be used to deploy a Tezos node and other tools on a Kubernetes cluster.
+
+We plan on moving our documentation to this site, but for now please visit https://github.com/oxheadalpha/tezos-k8s for more information.
+
+![Kubernetes](./static/img/kubernetes.svg)![Tezos](./static/img/tezos-black.svg)