docs: automatically publish Cluster API Book when release is published (#2)

Author: Djelibeybi

.github/workflows/build-cluster-api-provider-book.yaml

@@ -0,0 +1,43 @@
+name: Publish Cluster API Provider Book
+on:
+  # Rebuild docs when a release is published
+  release:
+    types: [published]
+  # Enable manual trigger
+  workflow_dispatch:
+
+jobs:
+  build-and-publish-book:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v2
+      with:
+        fetch-depth: 0
+    - name: Install mdbook
+      run: |
+        mkdir mdbook
+        curl -sSL https://github.com/rust-lang/mdBook/releases/download/v0.4.15/mdbook-v0.4.15-x86_64-unknown-linux-gnu.tar.gz | tar -xz --directory=./mdbook
+        echo `pwd`/mdbook >> $GITHUB_PATH
+        cargo install mdbook-admonish
+    - name: Deploy Book to GitHub Pages
+      run: |
+        # Build the HTML content
+        mdbook build -d book/ docs/
+
+        # Create and switch to the gh-pages work tree
+        git worktree add gh-pages gh-pages
+        cd $GITHUB_WORKSPACE/gh-pages
+
+        git config user.name "GitHub Actions"
+        git config user.email "oci-dax-tools_ww@oracle.com"
+
+        # Delete the ref to avoid keeping history.
+        git update-ref -d refs/heads/gh-pages
+        rm -rf *
+
+        mv $GITHUB_WORKSPACE/docs/book/* $GITHUB_WORKSPACE/gh-pages
+        touch $GITHUB_WORKSPACE/gh-pages/.nojekyll
+
+        git add .
+        git commit -m "Deploy $GITHUB_SHA to gh-pages"
+        git push --force-with-lease

.gitignore

@@ -1,4 +1,3 @@
-
 # Binaries for programs and plugins
 *.exe
 *.exe~
@@ -16,9 +15,11 @@ testbin/
 out/
 
 # Kubernetes Generated files - skip generated files, except for vendored files
-
 !vendor/**/zz_generated.*
 
+# Ignore the gh-pages repo in the main branch
+gh-pages/
+
 # editor and IDE paraphernalia
 .idea
 *.swp
@@ -41,4 +42,4 @@ test/e2e/data/infrastructure-oci/v1beta1/cluster-template-oracle-linux.yaml
 test/e2e/data/infrastructure-oci/v1beta1/cluster-template.yaml
 test/e2e/data/infrastructure-oci/v1beta1/cluster-template-custom-networking-seclist.yaml
 test/e2e/data/infrastructure-oci/v1beta1/cluster-template-custom-networking-nsg.yaml
-test/e2e/data/infrastructure-oci/v1beta1/cluster-template-multiple-node-nsg.yaml
+test/e2e/data/infrastructure-oci/v1beta1/cluster-template-multiple-node-nsg.yaml

README.md

@@ -1,57 +1,47 @@
 # Kubernetes Cluster API Provider OCI
 
-[![Go Report Card](https://goreportcard.com/badge/oracle/cluster-api-provider-oci)](https://goreportcard.com/report/oracle/cluster-api-provider-oci)
+[![Go Report Card](https://goreportcard.com/badge/github.com/oracle/cluster-api-provider-oci)](https://goreportcard.com/report/github.com/oracle/cluster-api-provider-oci)
 
+<!-- markdownlint-disable MD033 -->
 <img src="https://github.com/kubernetes/kubernetes/raw/master/logo/logo.png"  width="100">
 
 ------
 Kubernetes-native declarative infrastructure for OCI.
 
-### What is the Cluster API Provider OCI
+## Kubernetes Cluster API Provider for Oracle Cloud Infrastructure
 
-The [Cluster API (CAPOCI)][cluster_api] brings declarative, Kubernetes-style APIs to cluster creation, configuration and management.
+The [Cluster API Provier for OCI (CAPOCI)][cluster_api] brings declarative, Kubernetes-style APIs to cluster creation, configuration and management.
 
-The API itself is shared across multiple cloud providers allowing for true OCI
-hybrid deployments of Kubernetes.
+The Cluster API itself is shared across multiple cloud providers allowing for true hybrid deployments of Kubernetes.
 
 ### Features
 
 - Manages the bootstrapping of VCNs, gateways, subnets, network security groups and instances
-- Choice of Linux distribution between Oracle Linux 7 and 8.
-- Deploys Kubernetes Control plane into private subnets front-ended by a public load balancer.
-- Provide secure and sensible defaults.
+- Deploy either Oracle Linux or Ubuntu based instances using custom images built with the [Image Builder][image_builder_book] tool
+- Deploys Kubernetes Control plane into private subnets front-ended by a public load balancer
+- Provide secure and sensible defaults
 
 ### Getting Started
 
-- [Prerequisites][prerequisites]: Set up your OCI tenancy before using Cluster API for OCI.
-- [Deployment process][deployment]: Choose your deployment path
-- [Networking][networking]: Networking guide
-- Installation: 
-  - [Install Cluster API for OCI][install_cluster_api]
-  - [Install Workload Cluster][install_workload_cluster]
+You can find detailed documentation as well as a getting started guide in the [Cluster API Provider for OCI Book][capoci_book].
 
 ### Support Policy
-Cluster API and Kubernetes version compatibility
-
-#### Cluster API Versions
-|                              | v1beta1 (v1.0) |
-| ---------------------------- | -------------- |
-| OCI Provider v1beta1 (v0.1)  |        ✓       | 
-
-#### Supported Kubernetes versions
-
-|                              | v1.20 | v1.21 |
-| ---------------------------- | ----- | ----- |
-| OCI Provider v1beta1 (v0.1)  |   ✓   |   ✓  | 
 
 **NOTE:** As the versioning for this project is tied to the versioning of Cluster API, future modifications to this
 policy may be made to more closely align with other providers in the Cluster API ecosystem.
 
+#### Cluster API Versions
+
+|                                | v1beta1 (v1.0)   |
+| ------------------------------ | :--------------: |
+| OCI Provider v1beta1 (v0.1.0)  |       ✓          |
+
+#### Supported Kubernetes versions
 
+|                                | v1.20   | v1.21   |
+| ------------------------------ | :-----: | :-----: |
+| OCI Provider v1beta1 (v0.1.0)  |   ✓     |   ✓     |
 
-[cluster_api]: https://github.com/kubernetes-sigs/cluster-api-oci
-[deployment]: ./gs/overview.md
-[install_cluster_api]: ./gs/install_cluster_api.md
-[install_workload_cluster]: ./gs/install_workload_cluster.md
-[networking]: ./networking/networking.md
-[prerequisites]: ./prerequisites.md
+[cluster_api]: https://github.com/oracle/cluster-api-provider-oci
+[image_builder_book]: https://image-builder.sigs.k8s.io/capi/providers/oci.html
+[capoci_book]: https://oracle.github.io/cluster-api-provider-oci/

docs/book.toml

@@ -5,7 +5,11 @@ multilingual = false
 src = "src"
 title = "Kubernetes Cluster API Provider for Oracle Cloud Infrastructure"
 
+[preprocessor.admonish]
+command = "mdbook-admonish"
+
 [output.html]
-curly-quotes = true
-# git-repository-url = "https://sigs.k8s.io/cluster-api-provider-oci"
+curly-quotes = false
+git-repository-url = "https://github.com/oracle/cluster-api-provider-oci"
+additional-css = ["./src/css/mdbook-admonish.css"]
 # no-section-label = true