From 0d8062b27034e74368590a98f7d4a4b0863c8c29 Mon Sep 17 00:00:00 2001
From: FORESTIER Fabien <fabien.forestier@soprasteria.com>
Date: Thu, 23 Jan 2020 16:53:43 +0100
Subject: [PATCH] Fix some broken link and add some new ones
---
docs/components/custom-apps/web-app.md | 2 +-
docs/components/services/authentication.md | 4 ++--
docs/overview/index.md | 2 +-
mkdocs.yml | 22 ++++++++++++++--------
4 files changed, 18 insertions(+), 12 deletions(-)
diff --git a/docs/components/custom-apps/web-app.md b/docs/components/custom-apps/web-app.md
index fd93289..af51dd7 100644
--- a/docs/components/custom-apps/web-app.md
+++ b/docs/components/custom-apps/web-app.md
@@ -6,7 +6,7 @@ Organize a folders and files structure inside a project is never an easy task, a
We think that at the beginning we should just not overthink about it, choose one way to do it, keep to it, until a natural re-organization will happen if needed.
Here is our `/src` folder structure:
-
+
* `src/app/`: where the Angular code is located. With time we organized this part in different modules each taking care of one main functionnality. Here is the list of the modules:
* `core/`:
diff --git a/docs/components/services/authentication.md b/docs/components/services/authentication.md
index 0c17ed4..6ba6e8e 100644
--- a/docs/components/services/authentication.md
+++ b/docs/components/services/authentication.md
@@ -9,7 +9,7 @@ This service allows users to login to / logout from the Web Portal. Establishing
The service relies on
* the [API Gateway](../off-the-shelf-apps/api-gateway.md), in particular its Admin API;
-* external identity providers, which actually store user profiles and can verify user credentials. Despite being designed to potentially support different identity providers, in the present implementation only the [Legacy AUTH Identity Provider](../core/legacy-auth.md) is supported. A [middleware](../middlewares/legacy-auth-middleware.md) was developed, so as to facilitate the interaction between this service and the Legacy AUTH Identity Provider.
+* external identity providers, which actually store user profiles and can verify user credentials. Despite being designed to potentially support different identity providers, in the present implementation only the [Legacy AUTH Identity Provider](../core/legacy-auth.md) is supported. A [middleware](../middlewares/legacy-auth.md) was developed, so as to facilitate the interaction between this service and the Legacy AUTH Identity Provider.
@@ -33,7 +33,7 @@ This service provides five **endpoints**:
5. An **health** endpoint, `/health`, returning a `200` HTTP Status Code in case the service is healthy, `503` in the opposite case. For this service to be healthy, two conditions must be fulfilled:
* the [API Gateway](../off-the-shelf-apps/api-gateway.md) must be up;
- * the [Legacy AUTH Middleware](../middlewares/legacy-auth-middleware.md) must be up.
+ * the [Legacy AUTH Middleware](../middlewares/legacy-auth.md) must be up.
## Implementation
diff --git a/docs/overview/index.md b/docs/overview/index.md
index 855d87c..1df715b 100644
--- a/docs/overview/index.md
+++ b/docs/overview/index.md
@@ -143,7 +143,7 @@ S1 | Authentication | ... | [Link](../components/services/authentication.md) |
S2 | Changelog | [Link](https://gitlab.alpha.grandlyon.com/refonte-data/service-changelog) | [Link](../components/services/changelog.md) | Keeping track of the new features available to users throughout the developments|
S3 | Credits | ... | [Link](../components/services/credits.md) | Catalog of the Open Source initiatives powering the data.grandlyon.com project | |
S4 | CSV Catalog Downloader | ... | [Link](../components/services/csv-catalog-downloader.md) | Allowing users to download cached CSV exports of the metadata catalog | C3 |
-S5 | Mailer | ... | [Link](../components/services/mail.md) | Sending e-mails to both end- and back-office users | A6
+S5 | Mailer | ... | [Link](../components/services/mailer.md) | Sending e-mails to both end- and back-office users | A6
S6 | Media Library | ... | ... | Managing the images shown across the various pages of the Web Portal (organizations, posts, ...) |
S7 | Organizations | ... | ... | A catalog of the partners of the data.grandlyon.com, typically Data Providers | S6
S8 | Resources Helper | ... | ... | Assisting users in the composition of custom queries against the Core APIs |
diff --git a/mkdocs.yml b/mkdocs.yml
index ac0c0b8..236d07f 100644
--- a/mkdocs.yml
+++ b/mkdocs.yml
@@ -24,18 +24,23 @@ markdown_extensions:
nav:
- Home: index.md
- Overview: overview/index.md
- - Features: features/index.md
- Architecture: architecture/index.md
- Components:
- Core Components:
- Legacy AUTH: components/core/legacy-auth.md
+ - Custom apps:
+ - Web app: components/custom-apps/web-app.md
+ - Admin GUI: components/custom-apps/admin-gui.md
- Off-the-shelf applications:
- API Gateway: components/off-the-shelf-apps/api-gateway.md
- Headless CMS: components/off-the-shelf-apps/cms.md
- Search Engine: components/off-the-shelf-apps/elasticsearch.md
- Middlewares:
- - Legacy AUTH: components/middlewares/legacy-auth-middleware.md
- # - Proxies:
+ - Legacy AUTH: components/middlewares/legacy-auth.md
+ - Proxies:
+ - Web mapping services: components/proxies/web-mapping-services.md
+ - Miscellaneous:
+ - Maintenance page: components/miscellaneous/maintenance-page.md
- Indexers:
- Metadata and Data: components/indexers/metadata-and-data.md
- Editorial Content: components/indexers/editorial-content.md
@@ -43,14 +48,15 @@ nav:
- Authentication: components/services/authentication.md
- Changelog: components/services/changelog.md
- Credits: components/services/credits.md
+ - Reuses: components/services/reuses.md
- CSV Catalog Downloader: components/services/csv-catalog-downloader.md
- - Mail: components/services/mail.md
+ - Mailer: components/services/mailer.md
- Media Library: components/services/media-library.md
- Organizations: components/services/organizations.md
- - Resources: components/services/resources.md
- - Specific applications:
- - Web App: components/specific-apps/web-app.md
- - Admin GUI: components/specific-apps/admin-gui.md
+ - Resources helper: components/services/resources-helper.md
+ - Social media share helper: components/services/social-media-share-helper.md
+ - Tools:
+ - Minio master-slave mirror: components/tools/minio-master-slave-mirror.md
- Administration: administration/admin-tools.md
- Deployment:
- 2019 deployment of the first public beta version: deployment/beta-deployment.md
--
GitLab