Skip to content
Snippets Groups Projects
Commit 0fee4841 authored by Alessandro Cerioni's avatar Alessandro Cerioni
Browse files

Merge with doc-webapp

parents 6bf91495 603c382c
No related branches found
No related tags found
No related merge requests found
...@@ -9,7 +9,7 @@ This service allows users to login to / logout from the Web Portal. Establishing ...@@ -9,7 +9,7 @@ This service allows users to login to / logout from the Web Portal. Establishing
The service relies on The service relies on
* the [API Gateway](../off-the-shelf-apps/api-gateway.md), in particular its Admin API; * 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.
![authentication-service](../../assets/authentication-service.png) ![authentication-service](../../assets/authentication-service.png)
...@@ -33,7 +33,7 @@ This service provides five **endpoints**: ...@@ -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: 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 [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 ## Implementation
......
body {
background: #f2f2f2;
}
.md-content {
background: white;
border: 1px solid #dcd9d9;
margin-bottom: 2rem;
}
\ No newline at end of file
...@@ -139,6 +139,7 @@ In alphabetical order: ...@@ -139,6 +139,7 @@ In alphabetical order:
ID | Name | Repo | Doc | Usage | Deps ID | Name | Repo | Doc | Usage | Deps
--- | --- | --- | --- | --- | --- --- | --- | --- | --- | --- | ---
<<<<<<< HEAD
S1 | Authentication | [Link](https://forge.grandlyon.com/web-et-numerique/web-et-numerique-internet/data.grandlyon.com/web-portal/components/services/authentication) | [Link](../components/services/authentication.md) | Allowing users to create accounts and to perform logins and logouts | A3, S5 S1 | Authentication | [Link](https://forge.grandlyon.com/web-et-numerique/web-et-numerique-internet/data.grandlyon.com/web-portal/components/services/authentication) | [Link](../components/services/authentication.md) | Allowing users to create accounts and to perform logins and logouts | A3, S5
S2 | Changelog | [Link](https://forge.grandlyon.com/web-et-numerique/web-et-numerique-internet/data.grandlyon.com/web-portal/components/services/changelog) | [Link](../components/services/changelog.md) | Keeping track of the new features available to users throughout the developments| S2 | Changelog | [Link](https://forge.grandlyon.com/web-et-numerique/web-et-numerique-internet/data.grandlyon.com/web-portal/components/services/changelog) | [Link](../components/services/changelog.md) | Keeping track of the new features available to users throughout the developments|
S3 | Credits | [Link](https://forge.grandlyon.com/web-et-numerique/web-et-numerique-internet/data.grandlyon.com/web-portal/components/services/credits) | [Link](../components/services/credits.md) | Catalog of the Open Source initiatives powering the data.grandlyon.com project | | S3 | Credits | [Link](https://forge.grandlyon.com/web-et-numerique/web-et-numerique-internet/data.grandlyon.com/web-portal/components/services/credits) | [Link](../components/services/credits.md) | Catalog of the Open Source initiatives powering the data.grandlyon.com project | |
...@@ -149,6 +150,29 @@ S7 | Organizations | [Link](https://forge.grandlyon.com/web-et-numerique/web-et- ...@@ -149,6 +150,29 @@ S7 | Organizations | [Link](https://forge.grandlyon.com/web-et-numerique/web-et-
S8 | Resources Helper | [Link](https://forge.grandlyon.com/web-et-numerique/web-et-numerique-internet/data.grandlyon.com/web-portal/components/services/resources-helper) | [Link](../components/services/resources-helper.md) | Assisting users in the composition of custom queries against the Core APIs | S8 | Resources Helper | [Link](https://forge.grandlyon.com/web-et-numerique/web-et-numerique-internet/data.grandlyon.com/web-portal/components/services/resources-helper) | [Link](../components/services/resources-helper.md) | Assisting users in the composition of custom queries against the Core APIs |
S9 | Reuses | [Link](https://forge.grandlyon.com/web-et-numerique/web-et-numerique-internet/data.grandlyon.com/web-portal/components/services/reuses) | [Link](../components/services/reuses.md) | A catalog of the known reuses of the data shared through data.grandlyon.com | S6 S9 | Reuses | [Link](https://forge.grandlyon.com/web-et-numerique/web-et-numerique-internet/data.grandlyon.com/web-portal/components/services/reuses) | [Link](../components/services/reuses.md) | A catalog of the known reuses of the data shared through data.grandlyon.com | S6
S10 | Social Media Share Helper | [Link](https://forge.grandlyon.com/web-et-numerique/web-et-numerique-internet/data.grandlyon.com/web-portal/components/services/social-media-share-helper) | [Link](../components/services/social-media-share-helper.md) | ... | ... S10 | Social Media Share Helper | [Link](https://forge.grandlyon.com/web-et-numerique/web-et-numerique-internet/data.grandlyon.com/web-portal/components/services/social-media-share-helper) | [Link](../components/services/social-media-share-helper.md) | ... | ...
||||||| merged common ancestors
S1 | Authentication | ... | [Link](../components/services/authentication.md) | Allowing users to create accounts and to perform logins and logouts | A3, S5
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
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 |
S9 | Reuses | ... | ... | A catalog of the known reuses of the data shared through data.grandlyon.com | S6
S10 | Social Media Share Helper
=======
S1 | Authentication | ... | [Link](../components/services/authentication.md) | Allowing users to create accounts and to perform logins and logouts | A3, S5
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/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 |
S9 | Reuses | ... | ... | A catalog of the known reuses of the data shared through data.grandlyon.com | S6
S10 | Social Media Share Helper
>>>>>>> doc-webapp
### Custom applications ### Custom applications
ID | Name | Repo | Doc | Usage | Deps ID | Name | Repo | Doc | Usage | Deps
......
...@@ -17,6 +17,8 @@ theme: ...@@ -17,6 +17,8 @@ theme:
feature: feature:
tabs: false tabs: false
extra_css: [extra.css]
markdown_extensions: markdown_extensions:
- plantuml_markdown: - plantuml_markdown:
server: http://www.plantuml.com/plantuml server: http://www.plantuml.com/plantuml
...@@ -24,18 +26,42 @@ markdown_extensions: ...@@ -24,18 +26,42 @@ markdown_extensions:
nav: nav:
- Home: index.md - Home: index.md
- Overview: overview/index.md - Overview: overview/index.md
- Features: features/index.md
- Architecture: architecture/index.md - Architecture: architecture/index.md
- Components: - Components:
- Core Components: - Core Components:
- Legacy AUTH: components/core/legacy-auth.md - Legacy AUTH: components/core/legacy-auth.md
- Custom apps:
- Web App:
- Overview: components/custom-apps/web-app/overview.md
- Homepage: components/custom-apps/web-app/homepage.md
- Changelog: components/custom-apps/web-app/changelog.md
- Feedback: components/custom-apps/web-app/feedback.md
- Reuses: components/custom-apps/web-app/reuses.md
- Partners: components/custom-apps/web-app/partners.md
- Credits: components/custom-apps/web-app/credits.md
- Static pages: components/custom-apps/web-app/static-pages.md
- Dataset:
- Data: components/custom-apps/web-app/dataset/data.md
- Information: components/custom-apps/web-app/dataset/info.md
- API \& Downloads: components/custom-apps/web-app/dataset/resources.md
- Header: components/custom-apps/web-app/header.md
- Footer: components/custom-apps/web-app/footer.md
- Drafts: components/custom-apps/web-app/drafts.md
- Side Menu: components/custom-apps/web-app/side-menu.md
- Sign Up, Sign In, Sign Out: components/custom-apps/web-app/sign-up-in-out.md
- Contact: components/custom-apps/web-app/contact.md
- Search: components/custom-apps/web-app/search.md
- Admin GUI: components/custom-apps/admin-gui.md
- Off-the-shelf applications: - Off-the-shelf applications:
- API Gateway: components/off-the-shelf-apps/api-gateway.md - API Gateway: components/off-the-shelf-apps/api-gateway.md
- Headless CMS: components/off-the-shelf-apps/cms.md - Headless CMS: components/off-the-shelf-apps/cms.md
- Search Engine: components/off-the-shelf-apps/elasticsearch.md - Search Engine: components/off-the-shelf-apps/elasticsearch.md
- Middlewares: - Middlewares:
- Legacy AUTH: components/middlewares/legacy-auth-middleware.md - Legacy AUTH: components/middlewares/legacy-auth.md
# - Proxies: - Proxies:
- Web mapping services: components/proxies/web-mapping-services.md
- Miscellaneous:
- Maintenance page: components/miscellaneous/maintenance-page.md
- Indexers: - Indexers:
- Metadata and Data: components/indexers/metadata-and-data.md - Metadata and Data: components/indexers/metadata-and-data.md
- Editorial Content: components/indexers/editorial-content.md - Editorial Content: components/indexers/editorial-content.md
...@@ -43,14 +69,15 @@ nav: ...@@ -43,14 +69,15 @@ nav:
- Authentication: components/services/authentication.md - Authentication: components/services/authentication.md
- Changelog: components/services/changelog.md - Changelog: components/services/changelog.md
- Credits: components/services/credits.md - Credits: components/services/credits.md
- Reuses: components/services/reuses.md
- CSV Catalog Downloader: components/services/csv-catalog-downloader.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 - Media Library: components/services/media-library.md
- Organizations: components/services/organizations.md - Organizations: components/services/organizations.md
- Resources: components/services/resources.md - Resources helper: components/services/resources-helper.md
- Specific applications: - Social media share helper: components/services/social-media-share-helper.md
- Web App: components/specific-apps/web-app.md - Tools:
- Admin GUI: components/specific-apps/admin-gui.md - Minio master-slave mirror: components/tools/minio-master-slave-mirror.md
- Administration: administration/admin-tools.md - Administration: administration/admin-tools.md
- Deployment: - Deployment:
- 2019 deployment of the first public beta version: deployment/beta-deployment.md - 2019 deployment of the first public beta version: deployment/beta-deployment.md
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment