preview prs (#10)

* chore: test pr preview_prs * install vhs * add ttyd * add it from snap * boom * order matters sometimes * path matters sometimes * powers matters sometimes * sometimes stupidy matters... * meh * mah * booh * docs: aknowledgements and microservices deployment * chore: separate deployments and add /dashboard section * yeyeye
ForkbombEu · Apr 17, 2024 · 9f59e1b · 9f59e1b
1 parent df620bd
commit 9f59e1b
Show file tree

Hide file tree

Showing 14 changed files with 102 additions and 199 deletions.
diff --git a/.github/workflows/preview.yml b/.github/workflows/preview.yml
@@ -13,7 +13,7 @@ permissions:
   contents: write
   pages: write
   id-token: write
-
+  pull-requests: write
 
 jobs:
   deploy-preview:

diff --git a/docs/.vitepress/config.mts b/docs/.vitepress/config.mts
@@ -1,6 +1,5 @@
 import { defineConfig } from "vitepress";
 
-// https://vitepress.dev/reference/site-config
 export default defineConfig({
   base: "/DIDroom/",
   title: "Didroom ecosystem",
@@ -10,7 +9,6 @@ export default defineConfig({
   metaChunk: true,
 
   themeConfig: {
-    // https://vitepress.dev/reference/default-theme-config
     nav: [
       { text: "Home", link: "/" },
       { text: "Reference", link: "/intro" },
@@ -57,11 +55,17 @@ export default defineConfig({
         text: "🎮 Quickstart",
         link: "/quickstart",
         items: [
-          { text: "Software as a Service (SaaS)", link: "/quickstart#software-as-a-service-saas"},
-          { text: "On-Premise deployment", link: "/quickstart#on-premise-deployment" },
-		  { text: "Microservices deployment and provisioning", link: "/microservices#quickstart" }
+          { text: "Software as a Service (SaaS)", link: "/quickstart"},
         ],
       },
+      {
+        text: "🚀 Deployments",
+        items: [
+          { text: "On-Premise deployment", link: "/on-premise" },
+    		  { text: "Setup an issuance flows", link: "/dashboard/" },
+    		  { text: "Deploy your microservices", link: "/microservices/" },
+        ]
+      },
       {
         text: "Security and compliance",
         items: [
@@ -121,6 +125,10 @@ export default defineConfig({
           { text: "Contact Information", link: "#contact-information" },
         ],
       },
+      {
+        text: "🤟 Aknowledgements",
+        link: "/aknowledgements"
+      }
     ],
 
     socialLinks: [

diff --git a/docs/aknowledgements.md b/docs/aknowledgements.md
@@ -0,0 +1,5 @@
+# Aknowledgements
+
+<img align="left" src="./images/logo-ngi-trustchain-positive-rgb-PNG.png" width="365">
+
+Supported by [NGI TRUSTCHAIN](https://trustchain.ngi.eu/), which is made possible with financial support from the European Commission's [Next Generation Internet](https://ngi.eu/) programme.
diff --git a/docs/api-examples.md b/docs/api-examples.md
diff --git a/docs/dashboard/index.md b/docs/dashboard/index.md
@@ -0,0 +1,19 @@
+# Dashboard user manual
+
+## Create an organization
+
+<video controls="controls" src="https://github.com/ForkbombEu/signroom/raw/main/screenshots/videos/create_organization.webm" />
+
+## Setup a credential issuer metadata
+
+<video controls="controls" src="https://github.com/ForkbombEu/signroom/raw/main/screenshots/videos/create_organization.webm" />
+
+
+## Setup an authorization server metadata
+
+<video controls="controls" src="https://github.com/ForkbombEu/signroom/raw/main/screenshots/videos/create_organization.webm" />
+
+## Create a fully working credential issuing flow
+
+<video controls="controls" src="https://github.com/ForkbombEu/signroom/raw/main/screenshots/videos/issuance_flow.webm" />
+
diff --git a/docs/deploy.md b/docs/deploy.md
diff --git a/docs/images b/docs/images
@@ -0,0 +1 @@
+../images/
diff --git a/docs/index.md b/docs/index.md
@@ -14,7 +14,7 @@ hero:
       link: /quickstart
     - theme: brand
       text: JOIN NOW ↗
-      link: https://beta.signroom.io/register/
+      link: https://dashboard.didroom.com/register/
     - theme: alt 
       text: What is Didroom? ↗
       link: https://forkbomb.eu/solutions/didroom

diff --git a/docs/intro.md b/docs/intro.md
@@ -3,7 +3,7 @@
 Welcome to Didroom – your gateway to decentralized identity management and secure communication. Didroom empowers individuals and organizations to take control of their digital identities while ensuring privacy and security.
 Whether you're looking to streamline identity verification processes, enhance data security, or enable secure communication channels, Didroom provides the tools and infrastructure you need.
 
-You can quickly test, plug and deploy by using our service at [beta.signroom.io](https://beta.signroom.io) or install the whole ecosystem on-premise on your infrastructure.
+You can quickly test, plug and deploy by using our service at [dashboard.didroom.com](https://dashboard.didroom.com) or install the whole ecosystem on-premise on your infrastructure.
 
 
 ## How It Works

diff --git a/docs/markdown-examples.md b/docs/markdown-examples.md
diff --git a/docs/microservices.md → docs/microservices/index.md b/docs/microservices.md → docs/microservices/index.md
diff --git a/docs/on-premise.md b/docs/on-premise.md
@@ -0,0 +1,58 @@
+# On-Premise Deployment
+
+For users who prefer full control over their infrastructure and data, Didroom supports on-premise deployment. Follow these steps to deploy Didroom on your own infrastructure:
+
+::: tip
+If you are unfamiliar with servers, devops and unix commands look also at the [Software as a service](/quickstart) section that will allow you to define a credential issuance flow in minutes!
+:::
+
+### 1. clone the repo
+
+```bash
+git clone --recursive https://github.com/forkbombeu/signroom
+```
+
+::: warning
+
+Pay attention at the `--recursive` that will clone also the sub repositories!
+
+:::
+
+### 2. run the dashboard
+
+```bash
+cd signroom
+docker compose up --build
+```
+
+this will run the backend of the dirdroom control room available on the network at 
+
+```http
+http://localhost:8090/_
+```
+
+::: tip
+Pay attention at the final underscore, of the address
+:::
+
+### 3. login to the admin panel
+
+A default administrator user is created with the following defaults:
+
+**user**: `admin@example.org`
+
+**pass**: `adminadmin`
+
+### 4. Setup the DID service
+
+The only reaquired step to be configure is the DID federated service.
+You can ask for your admin domain/context as specified on [`dyne/W3C-DID`](https://github.com/dyne/W3C-DID?tab=readme-ov-file#claim-your-own-domain-context-as-an-admin)
+
+Follow the video:
+
+1. login into the dashboard
+2. go on the `features` collection
+3. select the `DID` feature
+4. insert you admin data
+
+<video controls src="https://raw.githubusercontent.com/ForkbombEu/signroom/main/screenshots/videos/setup-did.webm" />
diff --git a/docs/quickstart.md b/docs/quickstart.md
@@ -6,65 +6,11 @@ Get started quickly with Didroom by choosing one of the following deployment opt
 
 If you prefer a hassle-free experience and want to start using Didroom without setting up infrastructure, our Software as a Service (SaaS) option is the way to go. Follow these steps to get started:
 
-### 1. Sign up for a Didroom account on https://beta.signroom.io/register
+### 1. Sign up for a Didroom account on https://dashboard.didroom.com/register
 
 <video controls="controls" src="https://github.com/ForkbombEu/signroom/raw/main/screenshots/videos/registration.webm" />
 
 ### 2. Access the Didroom Control Room/Dashboard to setup you credential services
 
-For more detailed instructions, visit [Software as a Service (SaaS) Quickstart Guide](/quickstart#software-as-a-service-saas).
+For more detailed instructions, visit [Setup an issuance flows](/dashboard/).
 
-## On-Premise Deployment
-
-For users who prefer full control over their infrastructure and data, Didroom supports on-premise deployment. Follow these steps to deploy Didroom on your own infrastructure:
-
-### 1. clone the repo
-
-```bash
-git clone --recursive https://github.com/forkbombeu/signroom
-```
-
-::: warning
-
-Pay attention at the `--recursive` that will clone also the sub repositories!
-
-:::
-
-### 2. run the dashboard
-
-```bash
-cd signroom
-docker compose up --build
-```
-
-this will run the backend of the dirdroom control room available on the network at 
-
-```http
-http://localhost:8090/_
-```
-
-::: tip
-Pay attention at the final underscore, of the address
-:::
-
-### 3. login to the admin panel
-
-A default administrator user is created with the following defaults:
-
-**user**: `admin@example.org`
-
-**pass**: `adminadmin`
-
-### 4. Setup the DID service
-
-The only reaquired step to be configure is the DID federated service.
-You can ask for your admin domain/context as specified on [`dyne/W3C-DID`](https://github.com/dyne/W3C-DID?tab=readme-ov-file#claim-your-own-domain-context-as-an-admin)
-
-Follow the video:
-
-1. login into the dashboard
-2. go on the `features` collection
-3. select the `DID` feature
-4. insert you admin data
-
-<video controls src="https://raw.githubusercontent.com/ForkbombEu/signroom/main/screenshots/videos/setup-did.webm" />
diff --git a/docs/solution.md b/docs/solution.md
@@ -18,7 +18,7 @@ Our solution is divided into different repositories, each focusing on a specific
    ::: tip RESOURCES
    [GitHub](https://github.com/forkbombeu/signroom)
 
-   [Public beta](https://beta.signroom.io)
+   [Public beta](https://dashboard.didroom.com)
    :::
 
 ## DIDroom Mobile libs (Mobile Zencode)