docs: deploy documentation site (#210)

uncefact · Oct 15, 2024 · 16846a2 · 16846a2
1 parent bd3ee1c
commit 16846a2
Show file tree

Hide file tree

Showing 24 changed files with 142 additions and 85 deletions.
diff --git a/.github/workflows/build_publish_docs.yml b/.github/workflows/build_publish_docs.yml
@@ -0,0 +1,44 @@
+name: Deploy to GitHub Pages
+
+on:
+  push:
+    branches:
+      - next
+      - main
+
+jobs:
+  deploy:
+    name: Deploy to GitHub Pages
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-node@v3
+        with:
+          node-version: 20
+          cache: npm
+          cache-dependency-path: documentation/package-lock.json
+
+      - name: Install dependencies
+        working-directory: ./documentation
+        run: npm ci
+
+      - name: Build website
+        working-directory: ./documentation
+        run: npm run build
+        env:
+          DOCS_BASE_URL: ${{ vars.DOCS_BASE_URL }}
+          DOCS_URL: ${{ vars.DOCS_URL }}
+
+      # Popular action to deploy to GitHub Pages:
+      # Docs: https://github.com/peaceiris/actions-gh-pages#%EF%B8%8F-docusaurus
+      - name: Deploy to GitHub Pages
+        uses: peaceiris/actions-gh-pages@v3
+        with:
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+          # Build output to publish to the `gh-pages` branch:
+          publish_dir: ./documentation/build
+          # The following lines assign commit authorship to the official
+          # GH-Actions bot for deploys to `gh-pages` branch:
+          # https://github.com/actions/checkout/issues/13#issuecomment-724415212
+          # The GH actions bot is used by default if you didn't specify the two fields.
+          # You can swap them out with your own user credentials.
diff --git a/documentation/docs/_disclaimer.mdx b/documentation/docs/_disclaimer.mdx
@@ -0,0 +1,3 @@
+:::info
+Please note that this content is under development and is not ready for implementation. This status message will be updated as content development progresses.
+:::
diff --git a/documentation/docs/agent-configuration/config-agent-file.md b/documentation/docs/agent-configuration/config-agent-file.md
@@ -1,5 +1,9 @@
+import Disclaimer from './../\_disclaimer.mdx';
+
 # Config Agent File
 
+<Disclaimer />
+
 This guide explains the structure and options available within the agent config file. Use cases illustrating how to customise the config file for different scenarios are included.
 
 ## Diagram

diff --git a/documentation/docs/get-started/api-server-get-started/basic-operations.md b/documentation/docs/get-started/api-server-get-started/basic-operations.md
@@ -3,8 +3,12 @@ sidebar_label: 'Basic Operations'
 sidebar_position: 3
 ---
 
+import Disclaimer from './../../\_disclaimer.mdx';
+
 # Basic Operations
 
+<Disclaimer />
+
 Let's use the API docs at [`http://localhost:3332/api-docs`](http://localhost:3332/api-docs) to try some basic functions.
 
 ## Authentication

diff --git a/documentation/docs/get-started/api-server-get-started/installation.md b/documentation/docs/get-started/api-server-get-started/installation.md
@@ -3,8 +3,12 @@ sidebar_label: 'Installation'
 sidebar_position: 1
 ---
 
+import Disclaimer from './../../\_disclaimer.mdx';
+
 # Installation
 
+<Disclaimer />
+
 ## Prerequisites
 
 - [Node.js](https://nodejs.org/en/) version 20.12.2

diff --git a/documentation/docs/get-started/cli-get-started/basic-operations.md b/documentation/docs/get-started/cli-get-started/basic-operations.md
@@ -3,11 +3,11 @@ sidebar_label: 'Basic Operations'
 sidebar_position: 3
 ---
 
+import Disclaimer from './../../\_disclaimer.mdx';
+
 # Basic Operations
 
-:::info
-Please note that this content is still under development
-:::
+<Disclaimer />
 
 ## Create an identifer
 

diff --git a/documentation/docs/get-started/cli-get-started/installation.md b/documentation/docs/get-started/cli-get-started/installation.md
@@ -3,8 +3,12 @@ sidebar_label: 'Installation'
 sidebar_position: 1
 ---
 
+import Disclaimer from './../../\_disclaimer.mdx';
+
 # Installation
 
+<Disclaimer />
+
 ## Prerequisites
 
 - [Node.js](https://nodejs.org/en/) version 20.12.2

diff --git a/documentation/docs/get-started/demo-explorer-get-started/basic-operations.md b/documentation/docs/get-started/demo-explorer-get-started/basic-operations.md
@@ -3,11 +3,11 @@ sidebar_label: 'Basic Operations'
 sidebar_position: 3
 ---
 
+import Disclaimer from './../../\_disclaimer.mdx';
+
 # Basic Operations
 
-:::info
-To try this locally, you need to create a secure tunnel to your `localhost:3332`. You can use [**ngrok**](/docs/get-started/api-server-get-started/basic-operations#optional-using-https-for-localhost-by-using-ngrok) to do this.
-:::
+<Disclaimer />
 
 ## Create an identifier
 

diff --git a/documentation/docs/get-started/demo-explorer-get-started/installation.md b/documentation/docs/get-started/demo-explorer-get-started/installation.md
@@ -3,8 +3,12 @@ sidebar_label: 'Installation'
 sidebar_position: 1
 ---
 
+import Disclaimer from './../../\_disclaimer.mdx';
+
 # Installation
 
+<Disclaimer />
+
 ## Prerequisites
 
 - Clone [VCkit](https://github.com/uncefact/project-vckit.git) repository

diff --git a/documentation/docs/get-started/intro.md b/documentation/docs/get-started/intro.md
@@ -3,8 +3,12 @@ sidebar_position: 1
 slug: /get-started
 ---
 
+import Disclaimer from './../\_disclaimer.mdx';
+
 # Intro
 
+<Disclaimer />
+
 Let's discover **VCkit in less than 10 minutes**.
 
 ## Getting Started

diff --git a/documentation/docs/get-started/library-get-started/basic-operations.md b/documentation/docs/get-started/library-get-started/basic-operations.md
@@ -3,8 +3,12 @@ sidebar_label: 'Basic Operations'
 sidebar_position: 3
 ---
 
+import Disclaimer from './../../\_disclaimer.mdx';
+
 # Basic Operations
 
+<Disclaimer />
+
 ## Create Identifier
 
 Create a new file in **`src/create-identifier.ts`**, and add the following code.

diff --git a/documentation/docs/get-started/library-get-started/installation.md b/documentation/docs/get-started/library-get-started/installation.md
@@ -3,14 +3,12 @@ sidebar_label: 'Installation'
 sidebar_position: 1
 ---
 
-:::info
-You can find the complete source code of this tutorial [here](#)
-:::
-
-<!-- todo: update the github link of the example code -->
+import Disclaimer from './../../\_disclaimer.mdx';
 
 # Installation
 
+<Disclaimer />
+
 ## Prerequisites
 
 - [Node.js](https://nodejs.org/en/) version 20.12.2

diff --git a/documentation/docs/get-started/library-get-started/setup.md b/documentation/docs/get-started/library-get-started/setup.md
@@ -3,7 +3,12 @@ sidebar_label: 'Set Up'
 sidebar_position: 2
 ---
 
+import Disclaimer from './../../\_disclaimer.mdx';
+
 # Set up Agent
+
+<Disclaimer />
+
 To start using VCkit, we need to initialize an agent.
 ## Copy database file
 This tutorial will use the **did:web** method and we will need an available did:web identifier. To do that, we need to use the same database as the **VCkit API server** responsible for hosting the **did:web**.

diff --git a/documentation/docs/intro.md b/documentation/docs/intro.md
@@ -3,11 +3,12 @@ sidebar_position: 1
 slug: /
 
 ---
-# Introduction
-![Logo](/img/vckit-logo.svg)
 
-[![MIT License](https://img.shields.io/badge/License-MIT-green.svg)](https://choosealicense.com/licenses/mit/)
+import Disclaimer from './\_disclaimer.mdx';
+
+# Introduction
 
+<Disclaimer />
 
 ## What is VCkit
 
@@ -48,14 +49,5 @@ VCkit aims to provide the tools to equip your existing business systems to issue
 Contributions are always welcome!
 
 
-## Hall Of Fame
-Here we honor VCkit's biggest contributors
-* [Steven Capell](https://github.com/onthebreeze)
-* [Zach Zeus](https://github.com/zachzeus)
-* [Hoa Ngo](https://github.com/hoa-ngo-gs)
-* [Nam Hoang](https://github.com/namhoang1604)
-* [Yen Le](https://github.com/ldhyen99)
-
-
 ## Good First Issues
 We have a [list of good first issues](https://github.com/uncefact/project-vckit/issues/) that contain bugs that have a relatively limited scope. This is a great place for newcomers and beginners alike to get started, gain experience, and get familiar with our contribution process.
diff --git a/documentation/docs/manage-plugins.md b/documentation/docs/manage-plugins.md
@@ -2,8 +2,12 @@
 sidebar_position: 6
 ---
 
+import Disclaimer from './\_disclaimer.mdx';
+
 # How to create and manage plugins
 
+<Disclaimer />
+
 ## Create a new plugin
 
 ### Step 1: Init a new package

diff --git a/documentation/docs/vckit-plugins/credential-merkle-disclosure-proof.md b/documentation/docs/vckit-plugins/credential-merkle-disclosure-proof.md
@@ -1,5 +1,9 @@
+import Disclaimer from './../\_disclaimer.mdx';
+
 # Credential Merkle Disclosure Proof
 
+<Disclaimer />
+
 This package get idea from [merkle-disclosure-proof-2021](https://github.com/transmute-industries/merkle-disclosure-proof-2021) and implement to be a plugin for [Veramo](https://veramo.io/). It follows the proposal [Credential Merkle Disclosure Proof](https://w3c-ccg.github.io/Merkle-Disclosure-2021) to generate a Merkle proof from a credential.
 
 ## Usage

diff --git a/documentation/docs/vckit-plugins/credential-oa.md b/documentation/docs/vckit-plugins/credential-oa.md
@@ -1,5 +1,9 @@
+import Disclaimer from './../\_disclaimer.mdx';
+
 # Credential OpenAttestation Plugin
 
+<Disclaimer />
+
 - This plugin is used for issuing and verifying verifiable credential that adhere to OpenAttestation framework
 
 ## Usage

diff --git a/documentation/docs/vckit-plugins/credential-router.md b/documentation/docs/vckit-plugins/credential-router.md
@@ -1,5 +1,9 @@
+import Disclaimer from './../\_disclaimer.mdx';
+
 # Credential Router
 
+<Disclaimer />
+
 This plugin is used to route for issuing and verifying verifiable credential that will navigate to the correct plugin based on the proof format of the credential.
 
 ## Usage

diff --git a/documentation/docs/vckit-plugins/encrypted-storage.md b/documentation/docs/vckit-plugins/encrypted-storage.md
@@ -1,5 +1,9 @@
+import Disclaimer from './../\_disclaimer.mdx';
+
 # Encrypted Storage
 
+<Disclaimer />
+
 The encrypted storage plugin provides a secure storage for the agent. It is used to store the verifiable credentials that issued when call the `routeCreationVerifiableCredential` method.
 
 ## Usage

diff --git a/documentation/docs/vckit-plugins/intro.md b/documentation/docs/vckit-plugins/intro.md
@@ -2,7 +2,13 @@
 sidebar_position: 1
 slug: /vckit-plugins
 ---
+
+import Disclaimer from './../\_disclaimer.mdx';
+
 # Introduction
+
+<Disclaimer />
+
 VCkit is built on top of Veramo - a Javascript agent framework - to provide a structured and modular approach to building decentralized identity and credentialing solutions.
 ## Plugins system
 

diff --git a/documentation/docs/vckit-plugins/renderer.md b/documentation/docs/vckit-plugins/renderer.md
@@ -1,5 +1,9 @@
+import Disclaimer from './../\_disclaimer.mdx';
+
 # Renderer Plugin
 
+<Disclaimer />
+
 The Renderer Plugin is a module that provides rendering capabilities for verifiable credentials. It allows you to render verifiable credentials using different render methods, such as HTML templates.
 
 ## Implement a Render Provider

diff --git a/documentation/docs/vckit-plugins/revocation-list-2020.md b/documentation/docs/vckit-plugins/revocation-list-2020.md
@@ -1,5 +1,9 @@
+import Disclaimer from './../\_disclaimer.mdx';
+
 # Revocation list 2020
 
+<Disclaimer />
+
 The revocation list 2020 plugin is used to revoke and verify the verify credential based on the revocation list 2020 https://w3c-ccg.github.io/vc-status-rl-2020/
 
 ## Usage