diff --git a/.github/workflows/build_publish_docs.yml b/.github/workflows/build_publish_docs.yml new file mode 100644 index 00000000..752a67fb --- /dev/null +++ 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 new file mode 100644 index 00000000..232e4bd9 --- /dev/null +++ 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. +::: \ No newline at end of file diff --git a/documentation/docs/agent-configuration/config-agent-file.md b/documentation/docs/agent-configuration/config-agent-file.md index 7a12bd62..10f41c4c 100644 --- 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 + + 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 index ff7ac422..7a54a432 100644 --- 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 + + 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 index 7d929783..681af1b3 100644 --- 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 + + ## 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 index f56dd2e8..08cc978d 100644 --- 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 -::: + ## 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 index 21d93c50..080183f4 100644 --- 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 + + ## 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 index c3d00ffb..8197b4f7 100644 --- 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. -::: + ## 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 index 443bec47..fb43ad51 100644 --- 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 + + ## 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 index 14342450..2ba3b85e 100644 --- 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 + + 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 index 80e611f6..e1fee017 100644 --- 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 + + ## 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 index af0f501e..02c153f2 100644 --- 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](#) -::: - - +import Disclaimer from './../../\_disclaimer.mdx'; # Installation + + ## 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 index 84e22448..44e833a7 100644 --- 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 + + + 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 index fcdfdd05..8828e5d4 100644 --- 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 + ## 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. \ No newline at end of file diff --git a/documentation/docs/manage-plugins.md b/documentation/docs/manage-plugins.md index 7a94f1ed..6268ec5b 100644 --- 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 + + ## 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 index b9f81bcd..305fc408 100644 --- 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 + + 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 index 4d01dadd..f46fcf2f 100644 --- 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 + + - 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 index 434ddc02..d06af9ea 100644 --- 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 + + 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 index cfab42c3..59e29219 100644 --- 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 + + 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 index ee01b119..3cee00cf 100644 --- 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 + + + 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 index 807e8a79..4f98cab7 100644 --- 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 + + 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 index df84b79e..e6c18292 100644 --- 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 + + 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 diff --git a/documentation/docusaurus.config.js b/documentation/docusaurus.config.js index a7934765..1f6f380e 100644 --- a/documentation/docusaurus.config.js +++ b/documentation/docusaurus.config.js @@ -5,7 +5,10 @@ // See: https://docusaurus.io/docs/api/docusaurus-config // Todo: replace all links by actual ones -import {themes as prismThemes} from 'prism-react-renderer'; +import { themes as prismThemes } from 'prism-react-renderer'; + +const url = process.env.DOCS_URL || 'http://localhost'; +const baseUrl = process.env.DOCS_BASE_URL || '/'; /** @type {import('@docusaurus/types').Config} */ const config = { @@ -13,16 +16,11 @@ const config = { tagline: 'UN/CEFACT Verifiable Credentials Toolkit', favicon: 'img/vckit-logo.svg', - // Set the production url of your site here - url: 'https://your-docusaurus-site.example.com', - // Set the // pathname under which your site is served - // For GitHub pages deployment, it is often '//' - baseUrl: '/', + url, + baseUrl, - // GitHub pages deployment config. - // If you aren't using GitHub pages, you don't need these. - organizationName: 'facebook', // Usually your GitHub org/user name. - projectName: 'docusaurus', // Usually your repo name. + organizationName: 'uncefact', // Usually your GitHub org/user name. + projectName: 'project-vckit', // Usually your repo name. onBrokenLinks: 'throw', onBrokenMarkdownLinks: 'warn', @@ -42,18 +40,9 @@ const config = { ({ docs: { sidebarPath: './sidebars.js', - // Please change this to your repo. - // Remove this to remove the "edit this page" links. - editUrl: - 'https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/', - }, - blog: { - showReadingTime: true, - // Please change this to your repo. - // Remove this to remove the "edit this page" links. - editUrl: - 'https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/', + editUrl: 'https://github.com/uncefact/project-vckit/tree/main/', }, + blog: false, theme: { customCss: './src/css/custom.css', }, @@ -87,7 +76,7 @@ const config = { // }, // {to: '/readme', label: 'README', position: 'left'}, { - href: 'https://github.com/uncefact/project-vckit.git', + href: 'https://github.com/uncefact/project-vckit', label: 'GitHub', position: 'right', }, @@ -104,35 +93,9 @@ const config = { to: '/', }, ], - }, - { - title: 'Community', - items: [ - { - label: 'Discord', - href: '/', - }, - { - label: 'Twitter', - href: '/', - }, - ], - }, - { - title: 'More', - items: [ - { - label: 'Blog', - to: '/', - }, - { - label: 'GitHub', - href: '/', - }, - ], - }, + } ], - copyright: `Copyright © ${new Date().getFullYear()} VCkit. Built with Docusaurus.`, + copyright: `© United Nations Economic Commission for Europe`, }, prism: { theme: prismThemes.github, diff --git a/documentation/src/pages/readme.md b/documentation/src/pages/readme.md index d6e51cc6..1873d083 100644 --- a/documentation/src/pages/readme.md +++ b/documentation/src/pages/readme.md @@ -29,8 +29,8 @@ VCkit aims to provide the tools to equip your existing business systems to issue ## Documentation * [How to use agent config file](/docs/category/agent-configuration) -* [Component Documentation](/category/vckit-plugins) -* [Produce Guides for Plugin Creation/Management](#) +* [Component Documentation](/docs/category/vckit-plugins) +* [Produce Guides for Plugin Creation/Management](/docs/manage-plugins) @@ -38,15 +38,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. \ No newline at end of file