From 43f0d6fa24f972bd72467f014557528207f04707 Mon Sep 17 00:00:00 2001 From: Olivia Guyot Date: Thu, 26 Sep 2024 14:07:36 +0200 Subject: [PATCH] docs: improve project introduction, mention communication channels --- docs/.vitepress/config.ts | 6 +++--- docs/guide/introduction.md | 34 ++++++++++++++++++++++++++++++++++ docs/guide/why.md | 14 -------------- 3 files changed, 37 insertions(+), 17 deletions(-) create mode 100644 docs/guide/introduction.md delete mode 100644 docs/guide/why.md diff --git a/docs/.vitepress/config.ts b/docs/.vitepress/config.ts index b7f751258a..88feb0711e 100644 --- a/docs/.vitepress/config.ts +++ b/docs/.vitepress/config.ts @@ -8,7 +8,7 @@ export default defineConfig({ themeConfig: { // https://vitepress.dev/reference/default-theme-config nav: [ - { text: 'Guide', link: '/guide/why', activeMatch: '/guide/' }, + { text: 'Guide', link: '/guide/introduction', activeMatch: '/guide/' }, { text: 'Reference', link: '/reference/principles', @@ -49,7 +49,7 @@ function sidebarGuide() { { text: 'Guide', items: [ - { text: 'Why?', link: '/guide/why' }, + { text: 'Introduction', link: '/guide/introduction' }, { text: 'Prerequisites', link: '/guide/prerequisites' }, { text: 'Deploy', link: '/guide/deploy' }, { text: 'Configure', link: '/guide/configure' }, @@ -76,7 +76,7 @@ function sidebarGuide() { 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: 'Code guide', link: '/guide/code-guide' }, { text: 'Versioning', link: '/guide/versioning' }, ], }, diff --git a/docs/guide/introduction.md b/docs/guide/introduction.md new file mode 100644 index 0000000000..4fde0dffe7 --- /dev/null +++ b/docs/guide/introduction.md @@ -0,0 +1,34 @@ +--- +outline: deep +--- + +# Introduction + +## Why GeoNetwork-UI ? + +The GeoNetwork-UI project has been conceived as a way to depart from the long-standing and hard-to-use GeoNetwork interface, +and offer new functionalities and better user experience on top of the existing GeoNetwork API. Its core functionalities are +a **powerful search engine**, various **data visualization** components, and a better support for **non-geographic and open data** resources. + +Read the [Vision](./vision.html) section to understand better which approach is being adopted for this project and why. + +GeoNetwork-UI offers different applications suited to different use-cases. Applications are documented +in the [corresponding section](../apps/datahub.html). + +## Community + +GeoNetwork-UI is an open-source project just like GeoNetwork core, and is licensed under GPL-2.0. It is developed by a community of contributors from various organizations, mny of them also involved in the development of the GeoNetwork core project. + +### Contribution + +If you want to contribute, please read the guides in the "contributing" section of this website. You should also read the [Contribution Guide](https://github.com/geonetwork/geonetwork-ui/tree/main/CONTRIBUTING.md) in the GitHub repository. + +### Communication + +End users are [invited](https://discourse.osgeo.org/t/about-the-geonetwork-ui-category/59280) to join us on the GeoNetwork-UI forum on OsGeo Discourse: https://discourse.osgeo.org/c/geonetwork/ui + +For discussions on technical topics, you should head to the [GitHub discussions](https://github.com/geonetwork/geonetwork-ui/discussions) of the project. + +The community can also be reached through the [Gitter room chat](https://app.gitter.im/#/room/#geonetwork_geonetwork-ui:gitter.im) if needed. + +Lastly, bugs, issues and improvement requests should be reported on the [GitHub issue tracker](https://github.com/geonetwork/geonetwork-ui/issues). Thank you! diff --git a/docs/guide/why.md b/docs/guide/why.md deleted file mode 100644 index c5c85870ec..0000000000 --- a/docs/guide/why.md +++ /dev/null @@ -1,14 +0,0 @@ ---- -outline: deep ---- - -# Why GeoNetwork-UI ? - -The GeoNetwork-UI project has been conceived as a way to depart from the long-standing GeoNetwork web-ui application based on AngularJS, -and offer new functionalities and better user experience on top of the existing GeoNetwork API. Its core functionalities are -a **powerful search engine**, various **data visualization** components, and a better support for **non-geographic and open data** resources. - -Read the [Vision](./vision.html) section to understand better which approach is being adopted for this project and why. - -GeoNetwork-UI offers different applications suited to different use-cases. Applications are documented -in the [corresponding section](../apps/datahub.html).