diff --git a/docs/.vitepress/config.ts b/docs/.vitepress/config.ts index 0e2ece4e37..72f2735262 100644 --- 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 new file mode 100644 index 0000000000..b23718213e --- /dev/null +++ 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 new file mode 100644 index 0000000000..b23718213e --- /dev/null +++ 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 new file mode 100644 index 0000000000..b23718213e --- /dev/null +++ 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 new file mode 100644 index 0000000000..b23718213e --- /dev/null +++ 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 new file mode 100644 index 0000000000..b23718213e --- /dev/null +++ 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 new file mode 100644 index 0000000000..b23718213e --- /dev/null +++ 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 new file mode 100644 index 0000000000..b23718213e --- /dev/null +++ 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 new file mode 100644 index 0000000000..b23718213e --- /dev/null +++ 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 new file mode 100644 index 0000000000..b23718213e --- /dev/null +++ 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 new file mode 100644 index 0000000000..b23718213e --- /dev/null +++ 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 new file mode 100644 index 0000000000..b23718213e --- /dev/null +++ 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 new file mode 100644 index 0000000000..b23718213e --- /dev/null +++ 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 new file mode 100644 index 0000000000..b23718213e --- /dev/null +++ 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 new file mode 100644 index 0000000000..b23718213e --- /dev/null +++ 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 new file mode 100644 index 0000000000..b23718213e --- /dev/null +++ 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 new file mode 100644 index 0000000000..b23718213e --- /dev/null +++ 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 new file mode 100644 index 0000000000..b23718213e --- /dev/null +++ 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 new file mode 100644 index 0000000000..b23718213e --- /dev/null +++ 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 new file mode 100644 index 0000000000..b23718213e --- /dev/null +++ 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 new file mode 100644 index 0000000000..b23718213e --- /dev/null +++ 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 new file mode 100644 index 0000000000..b23718213e --- /dev/null +++ b/docs/guide/webcomponents.md @@ -0,0 +1,11 @@ +--- +outline: deep +--- + +# Chapter 1 + +Chapter 1 + +# Chapter 2 + +Chapter 2 diff --git a/docs/guide/why.md b/docs/guide/why.md new file mode 100644 index 0000000000..0f5f9b04bb --- /dev/null +++ b/docs/guide/why.md @@ -0,0 +1,16 @@ +--- +outline: deep +--- + +# Why geonetwork-ui ? + +L’ouverture et la démocratisation du partage et de la réutilisation des données publiques ont transformé le paysage du catalogage de données en France et en Europe. + +Une solution de catalogage moderne doit + +- Unifier les notions de Opendata et de données géographiques qui représentent 2 écosystèmes trop disjoints. +- Proposer des usages modernes et innovants pour la valorisation des données publiées. +- Fournir un moteur de recherche performant et redimensionnable, qui trouve l’information à la fois dans les métadonnées et les données. +- Valoriser la réutilisation des données via des API de recherche, analyse et exploration. + +Geonetwork-ui répond à ces besoins en mettant l’accent sur **l’expérience utilisateur**. diff --git a/docs/index.md b/docs/index.md index 47d2154749..0f909c0f8a 100644 --- a/docs/index.md +++ b/docs/index.md @@ -3,23 +3,35 @@ layout: home hero: - name: "GeoNetwork-UI Documentation" - text: "Documentation of various aspects of the project" - tagline: My great project tagline + name: "GeoNetwork-UI" + text: "Documentation" + tagline: Re-invent your open source data platform. actions: - theme: brand - text: Markdown Examples - link: /markdown-examples + text: Why? + link: guide/why - theme: alt - text: API Examples - link: /api-examples + text: Getting started + link: guide/getting-started features: - - title: Feature A - details: Lorem ipsum dolor sit amet, consectetur adipiscing elit - - title: Feature B - details: Lorem ipsum dolor sit amet, consectetur adipiscing elit - - title: Feature C - details: Lorem ipsum dolor sit amet, consectetur adipiscing elit + - icon: 🔗 + title: Connect + details: Connect geonetwork-ui platform to your favorite dataset + - icon: 📦 + title: Prepare + details: Arrange the dataset to make it talks. + - icon: 💫 + title: Publish + details: Make your dataset public and available. + - icon: 🔎 + title: Explore + details: Explore your data through a powerfull search engine. Tables, maps and dataviz charts. + - icon: 🤝 + title: Share + details: Share your work. + - icon: 💡 + title: Promote + details: Promote your data. --- diff --git a/docs/reference/app-config.md b/docs/reference/app-config.md new file mode 100644 index 0000000000..b23718213e --- /dev/null +++ b/docs/reference/app-config.md @@ -0,0 +1,11 @@ +--- +outline: deep +--- + +# Chapter 1 + +Chapter 1 + +# Chapter 2 + +Chapter 2 diff --git a/docs/reference/elasticsearch.md b/docs/reference/elasticsearch.md new file mode 100644 index 0000000000..b23718213e --- /dev/null +++ b/docs/reference/elasticsearch.md @@ -0,0 +1,11 @@ +--- +outline: deep +--- + +# Chapter 1 + +Chapter 1 + +# Chapter 2 + +Chapter 2 diff --git a/docs/reference/index.md b/docs/reference/index.md new file mode 100644 index 0000000000..b23718213e --- /dev/null +++ b/docs/reference/index.md @@ -0,0 +1,11 @@ +--- +outline: deep +--- + +# Chapter 1 + +Chapter 1 + +# Chapter 2 + +Chapter 2 diff --git a/docs/reference/organizations.md b/docs/reference/organizations.md new file mode 100644 index 0000000000..b23718213e --- /dev/null +++ b/docs/reference/organizations.md @@ -0,0 +1,11 @@ +--- +outline: deep +--- + +# Chapter 1 + +Chapter 1 + +# Chapter 2 + +Chapter 2 diff --git a/docs/reference/pivot-format.md b/docs/reference/pivot-format.md new file mode 100644 index 0000000000..b23718213e --- /dev/null +++ b/docs/reference/pivot-format.md @@ -0,0 +1,11 @@ +--- +outline: deep +--- + +# Chapter 1 + +Chapter 1 + +# Chapter 2 + +Chapter 2 diff --git a/docs/reference/principles.md b/docs/reference/principles.md new file mode 100644 index 0000000000..b23718213e --- /dev/null +++ b/docs/reference/principles.md @@ -0,0 +1,11 @@ +--- +outline: deep +--- + +# Chapter 1 + +Chapter 1 + +# Chapter 2 + +Chapter 2 diff --git a/docs/reference/routing.md b/docs/reference/routing.md new file mode 100644 index 0000000000..b23718213e --- /dev/null +++ b/docs/reference/routing.md @@ -0,0 +1,11 @@ +--- +outline: deep +--- + +# Chapter 1 + +Chapter 1 + +# Chapter 2 + +Chapter 2 diff --git a/docs/reference/search-fields.md b/docs/reference/search-fields.md new file mode 100644 index 0000000000..b23718213e --- /dev/null +++ b/docs/reference/search-fields.md @@ -0,0 +1,11 @@ +--- +outline: deep +--- + +# Chapter 1 + +Chapter 1 + +# Chapter 2 + +Chapter 2 diff --git a/docs/reference/state-management.md b/docs/reference/state-management.md new file mode 100644 index 0000000000..b23718213e --- /dev/null +++ b/docs/reference/state-management.md @@ -0,0 +1,11 @@ +--- +outline: deep +--- + +# Chapter 1 + +Chapter 1 + +# Chapter 2 + +Chapter 2 diff --git a/docs/reference/webcomponents.md b/docs/reference/webcomponents.md new file mode 100644 index 0000000000..b23718213e --- /dev/null +++ b/docs/reference/webcomponents.md @@ -0,0 +1,11 @@ +--- +outline: deep +--- + +# Chapter 1 + +Chapter 1 + +# Chapter 2 + +Chapter 2