Merge pull request #628 from molgenis/feat/make-docs-part-of-627

feat: make docs part of application
molgenis · Feb 12, 2024 · a8e572a · a8e572a
2 parents 056a02c + e82e6ab
commit a8e572a
Show file tree

Hide file tree

Showing 4 changed files with 24 additions and 1 deletion.
diff --git a/docs/developer_notes.md b/docs/developer_notes.md
@@ -20,5 +20,17 @@ docsify serve ./docs
 ```
 
 ## View
+```
+http://localhost:3000
+```
+
+## Github pages
+
+We have this configured through github pages instead of custom actions:
+
+- https://github.com/molgenis/molgenis-service-armadillo/settings/pages
+
+You can check its status on:
+
+- https://github.com/molgenis/molgenis-service-armadillo/actions
 
-And view the result on http://localhost:3000
diff --git a/ui/index.html b/ui/index.html
@@ -8,6 +8,7 @@
   </head>
   <body>
     <div id="app"></div>
+    <div class="row">
     <script type="module" src="/src/main.ts"></script>
   </body>
 </html>
diff --git a/ui/public/_docs/master b/ui/public/_docs/master
@@ -0,0 +1 @@
+../../../docs
diff --git a/ui/src/components/Navbar.vue b/ui/src/components/Navbar.vue
@@ -11,6 +11,15 @@
         Armadillo portal <small class="text-secondary">{{ version }}</small>
       </a>
       <form class="d-flex mt-1">
+        <span>
+          <a
+            type="button"
+            class="btn btn-dark"
+            href="/_docs/master/index.html"
+            target="_blank"
+            ><i class="bi bi-book"></i> Docs</a
+          >
+        </span>
         <span class="navbar-text p-2" v-show="username"
           ><i class="bi bi-person-fill"></i> {{ username }}
         </span>