feat(docs): initial doc structure

geonetwork · Jul 24, 2023 · b66bc7e · b66bc7e
1 parent d9365a1
commit b66bc7e
Show file tree

Hide file tree

Showing 34 changed files with 487 additions and 28 deletions.
diff --git a/docs/.vitepress/config.ts b/docs/.vitepress/config.ts
@@ -2,27 +2,117 @@ import { defineConfig } from 'vitepress'
 
 // https://vitepress.dev/reference/site-config
 export default defineConfig({
-  title: "GeoNetwork-UI Documentation",
-  description: "Documentation of various aspects of the project",
+  title: 'GeoNetwork-UI',
+  description: 'Documentation of various aspects of the project',
   themeConfig: {
     // https://vitepress.dev/reference/default-theme-config
     nav: [
       { text: 'Home', link: '/' },
-      { text: 'Examples', link: '/markdown-examples' }
-    ],
-
-    sidebar: [
+      { text: 'Guide', link: '/guide/why', activeMatch: '/guide/' },
+      { text: 'Reference', link: '/reference/', activeMatch: '/reference/' },
+      { text: 'Applications', link: '/apps/', activeMatch: '/apps/' },
       {
-        text: 'Examples',
-        items: [
-          { text: 'Markdown Examples', link: '/markdown-examples' },
-          { text: 'Runtime API Examples', link: '/api-examples' }
-        ]
-      }
+        text: 'Version XXX',
+        link: 'https://github.com/geonetwork/geonetwork-ui/releases',
+      },
     ],
 
+    sidebar: {
+      '/guide/': sidebarGuide(),
+      '/reference/': sidebarReference(),
+      '/apps/': sidebarApps(),
+    },
+
     socialLinks: [
-      { icon: 'github', link: 'https://github.com/vuejs/vitepress' }
-    ]
-  }
+      { icon: 'github', link: 'https://github.com/geonetwork/geonetwork-ui' },
+    ],
+
+    footer: {
+      message: 'Released under the GPL-2.0 license.',
+      copyright: 'Copyright © 2020-present GeoNetwork',
+    },
+
+    search: {
+      provider: 'local',
+    },
+  },
 })
+
+function sidebarGuide() {
+  return [
+    {
+      text: 'Guide',
+      items: [
+        { text: 'Why?', link: '/guide/why' },
+        { text: 'Getting started', link: '/guide/getting-started' },
+        { text: 'Prerequisites', link: '/guide/prerequisites' },
+        { text: 'Configure', link: '/guide/configure' },
+        { text: 'Deploy', link: '/guide/deploy' },
+        { text: 'Web components', link: '/guide/webcomponents' },
+        { text: 'Troubleshooting', link: '/guide/troubleshooting' },
+        { text: 'FAQ', link: '/guide/faq' },
+      ],
+    },
+    {
+      text: 'About',
+      items: [
+        { text: 'Vision', link: '/guide/vision' },
+        { text: 'Roadmap', link: '/guide/roadmap' },
+        { text: 'Contributors', link: '/guide/contributors' },
+        { text: 'Sponsors', link: '/guide/sponsors' },
+        { text: 'License', link: '/guide/license' },
+        { text: 'Maintenance', link: '/guide/maintenance' },
+      ],
+    },
+    {
+      text: 'Contributing',
+      items: [
+        { text: 'Development environment', link: '/guide/dev-environment' },
+        { text: 'Create a Pull Request', link: '/guide/create-a-pr' },
+        { text: 'Best practices', link: '/guide/best-practices' },
+        { text: 'Versioning', link: '/guide/versioning' },
+      ],
+    },
+  ]
+}
+
+function sidebarReference() {
+  return [
+    {
+      text: 'Architecture',
+      items: [
+        { text: 'Principles', link: '/reference/principles' },
+        { text: 'ElasticSearch index', link: '/reference/elasticsearch' },
+        { text: 'Organizations', link: '/reference/organizations' },
+        { text: 'State management', link: '/reference/state-management' },
+        { text: 'Routing', link: '/reference/routing' },
+        { text: 'Application configuration', link: '/reference/app-config' },
+        {
+          text: 'Pivot Format',
+          link: '/reference/pivot-format',
+        },
+      ],
+    },
+    {
+      text: 'Web Components',
+      link: '/reference/webcomponents',
+    },
+    {
+      text: 'Supported search fields',
+      link: '/reference/search-fields',
+    },
+  ]
+}
+
+function sidebarApps() {
+  return [
+    {
+      text: 'Applications',
+      items: [
+        { text: 'Datahub', link: '/apps/datahub' },
+        { text: 'Datafeeder', link: '/apps/datafeeder' },
+        { text: 'Editor', link: '/apps/editor' },
+      ],
+    },
+  ]
+}
diff --git a/docs/apps/datafeeder.md b/docs/apps/datafeeder.md
@@ -0,0 +1,11 @@
+---
+outline: deep
+---
+
+# Chapter 1
+
+Chapter 1
+
+# Chapter 2
+
+Chapter 2
diff --git a/docs/apps/datahub.md b/docs/apps/datahub.md
@@ -0,0 +1,11 @@
+---
+outline: deep
+---
+
+# Chapter 1
+
+Chapter 1
+
+# Chapter 2
+
+Chapter 2
diff --git a/docs/apps/editor.md b/docs/apps/editor.md
@@ -0,0 +1,11 @@
+---
+outline: deep
+---
+
+# Chapter 1
+
+Chapter 1
+
+# Chapter 2
+
+Chapter 2
diff --git a/docs/apps/index.md b/docs/apps/index.md
@@ -0,0 +1,11 @@
+---
+outline: deep
+---
+
+# Chapter 1
+
+Chapter 1
+
+# Chapter 2
+
+Chapter 2
diff --git a/docs/guide/best-practices.md b/docs/guide/best-practices.md
@@ -0,0 +1,11 @@
+---
+outline: deep
+---
+
+# Chapter 1
+
+Chapter 1
+
+# Chapter 2
+
+Chapter 2
diff --git a/docs/guide/configure.md b/docs/guide/configure.md
@@ -0,0 +1,11 @@
+---
+outline: deep
+---
+
+# Chapter 1
+
+Chapter 1
+
+# Chapter 2
+
+Chapter 2
diff --git a/docs/guide/contributors.md b/docs/guide/contributors.md
@@ -0,0 +1,11 @@
+---
+outline: deep
+---
+
+# Chapter 1
+
+Chapter 1
+
+# Chapter 2
+
+Chapter 2
diff --git a/docs/guide/create-a-pr.md b/docs/guide/create-a-pr.md
@@ -0,0 +1,11 @@
+---
+outline: deep
+---
+
+# Chapter 1
+
+Chapter 1
+
+# Chapter 2
+
+Chapter 2
diff --git a/docs/guide/deploy.md b/docs/guide/deploy.md
@@ -0,0 +1,11 @@
+---
+outline: deep
+---
+
+# Chapter 1
+
+Chapter 1
+
+# Chapter 2
+
+Chapter 2
diff --git a/docs/guide/dev-environment.md b/docs/guide/dev-environment.md
@@ -0,0 +1,11 @@
+---
+outline: deep
+---
+
+# Chapter 1
+
+Chapter 1
+
+# Chapter 2
+
+Chapter 2
diff --git a/docs/guide/faq.md b/docs/guide/faq.md
@@ -0,0 +1,11 @@
+---
+outline: deep
+---
+
+# Chapter 1
+
+Chapter 1
+
+# Chapter 2
+
+Chapter 2
diff --git a/docs/guide/getting-started.md b/docs/guide/getting-started.md
@@ -0,0 +1,11 @@
+---
+outline: deep
+---
+
+# Chapter 1
+
+Chapter 1
+
+# Chapter 2
+
+Chapter 2
diff --git a/docs/guide/license.md b/docs/guide/license.md
@@ -0,0 +1,11 @@
+---
+outline: deep
+---
+
+# Chapter 1
+
+Chapter 1
+
+# Chapter 2
+
+Chapter 2
diff --git a/docs/guide/maintenance.md b/docs/guide/maintenance.md
@@ -0,0 +1,11 @@
+---
+outline: deep
+---
+
+# Chapter 1
+
+Chapter 1
+
+# Chapter 2
+
+Chapter 2
diff --git a/docs/guide/prerequisites.md b/docs/guide/prerequisites.md
@@ -0,0 +1,11 @@
+---
+outline: deep
+---
+
+# Chapter 1
+
+Chapter 1
+
+# Chapter 2
+
+Chapter 2
diff --git a/docs/guide/roadmap.md b/docs/guide/roadmap.md
@@ -0,0 +1,11 @@
+---
+outline: deep
+---
+
+# Chapter 1
+
+Chapter 1
+
+# Chapter 2
+
+Chapter 2
diff --git a/docs/guide/sponsors.md b/docs/guide/sponsors.md
@@ -0,0 +1,11 @@
+---
+outline: deep
+---
+
+# Chapter 1
+
+Chapter 1
+
+# Chapter 2
+
+Chapter 2
diff --git a/docs/guide/troubleshooting.md b/docs/guide/troubleshooting.md
@@ -0,0 +1,11 @@
+---
+outline: deep
+---
+
+# Chapter 1
+
+Chapter 1
+
+# Chapter 2
+
+Chapter 2
diff --git a/docs/guide/versioning.md b/docs/guide/versioning.md
@@ -0,0 +1,11 @@
+---
+outline: deep
+---
+
+# Chapter 1
+
+Chapter 1
+
+# Chapter 2
+
+Chapter 2
diff --git a/docs/guide/vision.md b/docs/guide/vision.md
@@ -0,0 +1,11 @@
+---
+outline: deep
+---
+
+# Chapter 1
+
+Chapter 1
+
+# Chapter 2
+
+Chapter 2
diff --git a/docs/guide/webcomponents.md b/docs/guide/webcomponents.md
@@ -0,0 +1,11 @@
+---
+outline: deep
+---
+
+# Chapter 1
+
+Chapter 1
+
+# Chapter 2
+
+Chapter 2