diff --git a/docs/overview/index.md b/docs/overview/index.md index 1df715b36de712075d2348c7f178ea392eb0738f..1a94b35a66dbbd2cb3a23735a3cd20468abe72df 100644 --- a/docs/overview/index.md +++ b/docs/overview/index.md @@ -104,15 +104,15 @@ A6 | Postfix | [Link](http://www.postfix.org/) | SMTP Server ### Middlewares -ID | Name | Repo | Doc | Usage | Deps ---- | --- | --- | --- | --- | --- -M1 | Legacy AUTH | ... | ... | Facilitating the interaction between the Web Portal Authentication Service (S1) and the AUTHN/AUTHZ Service (C1) hosted by data.grandlyon.com's Core macro-component | C1, S5 +ID | Name | Lang | Repo | Doc | Usage | Deps +--- | --- | --- | --- | --- | --- | --- +M1 | Legacy AUTH | TS | [Link](https://forge.grandlyon.com/web-et-numerique/web-et-numerique-internet/data.grandlyon.com/web-portal/components/middlewares/legacy-auth) | [Link](../components/middlewares/legacy-auth.md) | Facilitating the interaction between the Web Portal Authentication Service (S1) and the AUTHN/AUTHZ Service (C1) hosted by data.grandlyon.com's Core macro-component | C1, S5 ### Proxies ID | Name | Repo | Doc | Usage | Deps --- | --- | --- | --- | --- | --- -P1 | Map Proxy | ... | ... | Proxying requests that the Web Portal performs against the cartographic Web Services (WMS, MVT) hosted by data.grandlyon.com's Core macro-component| A1, C4 +P1 | Web Mapping Services | [Link](https://forge.grandlyon.com/web-et-numerique/web-et-numerique-internet/data.grandlyon.com/web-portal/components/proxies/web-mapping-services) | [Link](../components/proxies/web-mapping-services.md) | Proxying requests that the Web Portal performs against the cartographic Web Services (WMS, MVT) hosted by data.grandlyon.com's Core macro-component| A1, C4 @@ -122,14 +122,14 @@ The following custom indexers are used to index documents in Elasticsearch (A1) ID | Name | Repo | Doc | Usage | Deps --- | --- | --- | --- | --- | --- -I1 | Editorial Content | ... | ... | Indexing the posts and pages edited in Ghost | A2 +I1 | Editorial Content | [Link](https://forge.grandlyon.com/web-et-numerique/web-et-numerique-internet/data.grandlyon.com/web-portal/components/indexers/editorial-content) | ... | Indexing the posts and pages edited via Ghost | A2 I2 | Metadata and Data | ... | ... | Indexing the metadata and data hosted, respectively, by data.grandlyon.com's catalog (C3) and database (C4) | C3, C4 ### Tools ID | Name | Repo | Doc | Usage | Deps --- | --- | --- | --- | --- | --- -T1 | MinIO master-slave replication tool | ... | ... | Replicating/mirroring the assets stored in one "master" instance of MinIO to some other "slave" instances | A5 +T1 | MinIO master-slave replication tool | [Link](https://forge.grandlyon.com/web-et-numerique/web-et-numerique-internet/data.grandlyon.com/web-portal/components/tools/minio-master-slave-mirror) | [Link](../components/tools/minio-master-slave-mirror.md) | Replicating/mirroring the assets stored in one "master" instance of MinIO to some other "slave" instances | A5 @@ -139,28 +139,28 @@ In alphabetical order: ID | Name | Repo | Doc | Usage | Deps --- | --- | --- | --- | --- | --- -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 +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| +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 | | +S4 | CSV Catalog Downloader | [Link](https://forge.grandlyon.com/web-et-numerique/web-et-numerique-internet/data.grandlyon.com/web-portal/components/services/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](https://forge.grandlyon.com/web-et-numerique/web-et-numerique-internet/data.grandlyon.com/web-portal/components/services/mailer) | [Link](../components/services/mailer.md) | Sending e-mails to both end- and back-office users | A6 +S6 | Media Library | [Link](https://forge.grandlyon.com/web-et-numerique/web-et-numerique-internet/data.grandlyon.com/web-portal/components/services/media-library) | [Link](../components/services/media-library.md) | Managing the images shown across the various pages of the Web Portal (organizations, posts, ...) | +S7 | Organizations | [Link](https://forge.grandlyon.com/web-et-numerique/web-et-numerique-internet/data.grandlyon.com/web-portal/components/services/organizations) | [Link](../components/services/organizations.md) | A catalog of the partners of the data.grandlyon.com, typically Data Providers | S6 +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 +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) | ... | ... ### Custom applications ID | Name | Repo | Doc | Usage | Deps --- | --- | --- | --- | --- | --- -D1 | Web App | ... | ... | Web Application representing the actual Web Portal as seen by its end-users | S[1,9] -D2 | Admin GUI | ... | ... | Back-office oriented web application allowing users to administrate some of the editorial content as well as the configuration of some functionality | S[1,3], S[6,9] +D1 | Web App | [Link](https://forge.grandlyon.com/web-et-numerique/web-et-numerique-internet/data.grandlyon.com/web-portal/components/custom-apps/web-app) | ... | Web Application representing the actual Web Portal as seen by its end-users | S[1,9] +D2 | Admin GUI | [Link](https://forge.grandlyon.com/web-et-numerique/web-et-numerique-internet/data.grandlyon.com/web-portal/components/custom-apps/web-app) | ... | Back-office oriented web application allowing users to administrate some of the editorial content as well as the configuration of some functionality | S[1,3], S[6,9] ### Miscellaneous ID | Name | Repo | Doc | Usage | Deps --- | --- | --- | --- | --- | --- -M1 | Maintenance Page | ... | ... | +M1 | Maintenance Page | [Link](https://forge.grandlyon.com/web-et-numerique/web-et-numerique-internet/data.grandlyon.com/web-portal/components/miscellaneous/maintenance-page) | A static HTML page to be used whenever the official site has to go offline because of some maintenance tasks | <!-- <span id="test">mon test</span> <a href='#test'>link</a> -->