From 7b9babd4cab662f49599d41aae2d7bd3c63f9d23 Mon Sep 17 00:00:00 2001 From: Jeremy Date: Wed, 31 Jan 2024 09:20:46 +0200 Subject: [PATCH 1/2] Docs: structure updates --- docs/mkdocs-base.yml | 6 ++++++ .../user/guide/{forgot_password.md => forgot-password.md} | 0 docs/src/user/guide/index.md | 2 +- .../manual/{forgot_password.md => forgot-password.md} | 0 docs/src/user/manual/index.md | 8 ++++---- docs/src/user/manual/{signup.md => sign-up.md} | 0 6 files changed, 11 insertions(+), 5 deletions(-) rename docs/src/user/guide/{forgot_password.md => forgot-password.md} (100%) rename docs/src/user/manual/{forgot_password.md => forgot-password.md} (100%) rename docs/src/user/manual/{signup.md => sign-up.md} (100%) diff --git a/docs/mkdocs-base.yml b/docs/mkdocs-base.yml index 2a42fbbf..2bd36004 100755 --- a/docs/mkdocs-base.yml +++ b/docs/mkdocs-base.yml @@ -53,16 +53,21 @@ nav: - user/guide/index.md - Registering: user/guide/registering.md - Logging In: user/guide/logging-in.md + - Forgot Password: user/guide/forgot-password.md - Profile Settings: user/guide/profile-management.md - Organisation Management: user/guide/organisation-management.md - Search Metadata: user/guide/search-metadata.md - Upload Metadata: user/guide/create-metadata.md - Edit Metadata: user/guide/edit-metadata.md - Using the Map: user/guide/map.md + - Logging out: user/guide/logout.md - Report Issues: user/guide/opening-issues.md #Linked in a document - Manual: - user/manual/index.md - Home Page: user/manual/home.md + - Sign Up Page: user/manual/sign-up.md + - Login Page: user/manual/login.md + - Forgot Password: user/manual/forgot-password.md - Dashboard: user/manual/dashboard.md - Profile: user/manual/profile-page.md - Profile Settings: user/manual/profile-settings.md @@ -72,6 +77,7 @@ nav: - Organisations: user/manual/organisation.md - About: user/manual/about.md - Help: user/manual/help.md + - Logout Page: user/manual/logout.md - User Roles: user/manual/user-roles.md - Metadata Standard: - user/research/index.md diff --git a/docs/src/user/guide/forgot_password.md b/docs/src/user/guide/forgot-password.md similarity index 100% rename from docs/src/user/guide/forgot_password.md rename to docs/src/user/guide/forgot-password.md diff --git a/docs/src/user/guide/index.md b/docs/src/user/guide/index.md index ec49038b..357a7064 100755 --- a/docs/src/user/guide/index.md +++ b/docs/src/user/guide/index.md @@ -6,6 +6,7 @@ The guide section of the documentation provides short narrative/workflow based t * **[Registering:](./registering.md)** This page will show you how to register on the platform. * **[Logging In:](./logging-in.md)** This page will show you how to log in to the platform. +* **[Forgot Password:](./forgot-password.md)** This page will help you to reset your password in case it is forgotten. * **[Profile Settings:](./profile-management.md)** This page will show you how to manage your profile on the platform. * **[Organisation Management:](./organisation-management.md)** This page will show you how to manage organisations on the platform. * **[Search Metadata:](./search-metadata.md)** This page will show you how to search for metadata on the platform. @@ -14,4 +15,3 @@ The guide section of the documentation provides short narrative/workflow based t * **[Map:](./map.md)** This page will show you how visualise metadata on the map. * **[Report Issues:](./opening-issues.md)** This page will show you how to open tickets about issues you may encounter. * **[Log Out:](./logout.md)** This page will help you how to logout from the site. -* **[Forgot Password:](./forgot_password.md)** This page will help you to reset your password in case it is forgotten. diff --git a/docs/src/user/manual/forgot_password.md b/docs/src/user/manual/forgot-password.md similarity index 100% rename from docs/src/user/manual/forgot_password.md rename to docs/src/user/manual/forgot-password.md diff --git a/docs/src/user/manual/index.md b/docs/src/user/manual/index.md index 59978b3e..782f68d2 100755 --- a/docs/src/user/manual/index.md +++ b/docs/src/user/manual/index.md @@ -6,6 +6,9 @@ as a reference for the application. For narrative/workflow-based tutorials, users may prefer to work through our [user guide](../guide/index.md). * **[Home Page:](./home.md)** This is the `landing page` that users arrive on when they open the site. +* **[Sign Up:](./sign-up.md)** This is the `Sign Up` page where the user can create an account. +* **[Login:](./login.md)** This is the `Login` page from here the user can log in. +* **[Forgot Password:](./forgot-password.md)** This is the `Forgot Password` page from here the user can reset their password. * **[Dashboard:](./dashboard.md)** This is a central notification hub for communications from the SAEOSS-Portal platform. * **[Profile:](./profile-page.md)** The profile page provides a preview of what a user's profile will look like when viewed by other users on the platform. * **[Profile Settings:](./profile-settings.md)** On the profile settings page, all user profile-related settings can be managed. @@ -15,8 +18,5 @@ users may prefer to work through our [user guide](../guide/index.md). * **[Organisations:](./organisation.md)** This is the `Organisations` page that allows all users to see all organisations on the platform. * **[About:](./about.md)** This is the `About` page where users can learn more about the site. * **[Help:](./help.md)** The help page is the documentation site. +* **[Log Out:](./logout.md)** This is the `Log Out` page from here the user can log out. * **[User Roles:](./user-roles.md)** Access to data and functionalities on the SAEOSS-Portal platform is governed by user roles and permissions. -* **[Sign Up:](./signup.md)** This is the `Sign Up` page where the user can create an account. -* **[Login:](./login.md)** This is the `Login` page from here the user can log in. -* **[Log Out:](./logout.md)** This is the `Log Out` page from here the user can log out. -* **[Forgot Password:](./forgot_password.md)** This is the `Forgot Password` page from here the user can reset their password. diff --git a/docs/src/user/manual/signup.md b/docs/src/user/manual/sign-up.md similarity index 100% rename from docs/src/user/manual/signup.md rename to docs/src/user/manual/sign-up.md From deda68026240f84ee697a383913c344288733f3e Mon Sep 17 00:00:00 2001 From: Jeremy Date: Tue, 2 Apr 2024 08:37:47 +0200 Subject: [PATCH 2/2] Docs: fix build errors --- docs/mkdocs-base.yml | 4 ++-- docs/src/developer/documentation/index.md | 1 - docs/src/user/guide/index.md | 1 + 3 files changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/mkdocs-base.yml b/docs/mkdocs-base.yml index c0133d51..a2390d8f 100755 --- a/docs/mkdocs-base.yml +++ b/docs/mkdocs-base.yml @@ -61,7 +61,8 @@ nav: - Edit Metadata: user/guide/edit-metadata.md - Using the Map: user/guide/map.md - Logging out: user/guide/logout.md - - Report Issues: user/guide/opening-issues.md #Linked in a document + - Report Issues: user/guide/opening-issues.md + - Help Page: user/guide/help.md - Manual: - user/manual/index.md - Home Page: user/manual/home.md @@ -135,7 +136,6 @@ nav: - CSW: developer/manual/csw.md - Documentation: - developer/documentation/index.md - - Setting up mkdocs: developer/documentation/make-docs.md - Writing Documentation: developer/documentation/writing.md - License: about/license.md - DevOps: diff --git a/docs/src/developer/documentation/index.md b/docs/src/developer/documentation/index.md index dc41c406..e455ac63 100644 --- a/docs/src/developer/documentation/index.md +++ b/docs/src/developer/documentation/index.md @@ -15,5 +15,4 @@ license: This program is free software; you can redistribute it and/or modify it This documentation describes how to set up and contribute to the project documentation. It consists of: -* **[Setting up mkdocs:](./make-docs.md)** explains how to setup mkdocs for your project. * **[Writing Documentation:](./writing.md)** explains how to contribute to the documentation and various standards. diff --git a/docs/src/user/guide/index.md b/docs/src/user/guide/index.md index 8091fd50..323f5555 100755 --- a/docs/src/user/guide/index.md +++ b/docs/src/user/guide/index.md @@ -28,3 +28,4 @@ The guide section of the documentation provides short narrative/workflow based t * **[Map:](./map.md)** This page will show you how visualise metadata on the map. * **[Report Issues:](./opening-issues.md)** This page will show you how to open tickets about issues you may encounter. * **[Log Out:](./logout.md)** This page will help you how to logout from the site. +* **[Help Page:](./help.md)** This page will show you how to access this documentation from the platform.