Skip to content

Commit 7522cfe

Browse files
authored
Merge pull request #147 from georchestra/documentation
Update of the doc page for the 3 languages
2 parents 46cba97 + 8ff1a66 commit 7522cfe

File tree

5 files changed

+143
-36
lines changed

5 files changed

+143
-36
lines changed

_includes/card_doc_tool.html

+9
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
<div class="col-md-4 col-sm-12 p-0 mb-1">
2+
<a class="card-tool-doc" href="{{ include.site_url }}" target="_blank">
3+
<img class="rounded-1 me-3" src="{{ include.img_url }}" alt="Icône {{ include.name }}" style="width: 3em;">
4+
<div>
5+
<h4>{{ include.name }}</h4>
6+
<p>{{ include.text }}</p>
7+
</div>
8+
</a>
9+
</div>

css/georchestra-theme.css

+31
Original file line numberDiff line numberDiff line change
@@ -10394,4 +10394,35 @@ a.nav-link {
1039410394

1039510395
#cardPresentation img {
1039610396
display: none;
10397+
}
10398+
10399+
/* Documentation > card tool */
10400+
.card-tool-doc {
10401+
display: flex;
10402+
background-color: var(--bs-gray-100);
10403+
color: #495057!important;
10404+
align-items: center;
10405+
flex-direction: row;
10406+
flex-wrap: nowrap;
10407+
align-content: center;
10408+
justify-content: flex-start;
10409+
padding: 1em;
10410+
border-radius: 0.3em;
10411+
text-decoration: none;
10412+
margin: 0 0.5em 0.5em 0;
10413+
height: 100%;
10414+
}
10415+
10416+
.card-tool-doc:hover {
10417+
text-decoration: none;
10418+
background-color: #cea0cb26;
10419+
}
10420+
10421+
.card-tool-doc p{
10422+
line-height:1.1;
10423+
margin:0;
10424+
}
10425+
10426+
.card-tool-doc h4{
10427+
margin: 0 0 5px 0;
1039710428
}

documentation.md

+34-12
Original file line numberDiff line numberDiff line change
@@ -6,19 +6,41 @@ uid: documentation
66
permalink: /documentation.html
77
---
88

9-
The installation and configuration documentation is now part of the [source repository](https://github.com/georchestra/georchestra/).
10-
Please refer to the [README](https://github.com/georchestra/georchestra/blob/master/README.md) and explore the links.
9+
<p class="lead">
10+
From this page you can access the installation and user documentation for the geOrchestra platform.
11+
</p>
1112

12-
The **reference manuals** of the underlying standalone modules are also valuable sources of information:
13+
<div class="row py-2 d-flex align-items-stretch">
14+
{% include card_doc_tool.html img_url="/favicon.ico" name="geOrchestra" text="Installation guide" site_url="https://github.com/georchestra/georchestra/blob/master/docs/index.md" %}
15+
</div>
1316

14-
* on the [GeoServer website](https://docs.geoserver.org/maintain/en/user/) for the 2.20 version,
15-
* on the [GeoNetwork website](https://www.geonetwork-opensource.org/manuals/4.0.x/en/) for the 4 version,
16-
* on the [GeoWebCache website](https://www.geowebcache.org/docs/current/index.html) for the 1.16 version.
17+
## The different components of geOrchestra
1718

18-
## OID registry
19+
### View
20+
<div class="row py-2 d-flex align-items-stretch">
21+
{% include card_doc_tool.html img_url="/public/icons/mapstore_icon.svg" name="MapStore2" text="An advanced geographic data viewer" site_url="https://docs.georchestra.org/mapstore2/" %}
22+
{% include card_doc_tool.html img_url="/public/icons/datafeeder_icon.svg" name="Land registry plugin" text="A plugin for land registry consultation" site_url="https://docs.georchestra.org/cadastrapp/" %}
23+
{% include card_doc_tool.html img_url="/public/icons/mapstore_icon.svg" name="Mviewer" text="A geographic data viewer for the public" site_url="https://mviewerdoc.readthedocs.io/fr/latest/" %}
24+
{% include card_doc_tool.html img_url="/public/icons/datafeeder_icon.svg" name="Urban planning plugin" text="A plugin for consulting planning documents" site_url="https://docs.georchestra.org/mapstore2-urbanisme/fr/latest/" %}
25+
</div>
1926

20-
The geOrchestra project [has been assigned](https://www.iana.org/assignments/enterprise-numbers/enterprise-numbers)
21-
an Object Identifier (OID): `1.3.6.1.4.1.53611`. It is particularly useful to
22-
manage custom LDAP objects specific to geOrchestra. Below this root OID, the
23-
geOrchestra community maintains its own
24-
[OID registry]({{ site.baseurl }}{% link oid.md %}).
27+
### Supply
28+
<div class="row py-2 d-flex align-items-stretch">
29+
{% include card_doc_tool.html img_url="/public/icons/datafeeder_icon.svg" name="Datafeeder" text="A data integration wizard" site_url="https://georchestra-user-guide.readthedocs.io/en/latest/setup/datafeeder/" %}
30+
</div>
31+
32+
### Publish
33+
<div class="row py-2 d-flex align-items-stretch">
34+
{% include card_doc_tool.html img_url="/public/icons/geonetwork_icon.svg" name="GeoNetwork" text="A metadata catalogue" site_url="https://geonetwork-opensource.org/manuals/3.12.x/fr/" %}
35+
{% include card_doc_tool.html img_url="/public/icons/datafeeder_icon.svg" name="GeoServer" text="A powerful geographic data server that complies with OGC WxS standards" site_url="https://docs.geoserver.org/stable/en/user/" %}
36+
{% include card_doc_tool.html img_url="/public/icons/geowebcache_icon.svg" name="GeoWebCache" text="A tile server" site_url="https://www.osgeo.org/projects/geowebcache/" %}
37+
{% include card_doc_tool.html img_url="/public/icons/geowebcache_icon.svg" name="Data API" text="An open data API complying with the new OGC 'Features API' standards" site_url="https://github.com/georchestra/data-api" %}
38+
</div>
39+
40+
### Manage
41+
<div class="row py-2 d-flex align-items-stretch">
42+
{% include card_doc_tool.html img_url="/public/icons/geofence_icon.svg" name="GeoFence" text="A module for advanced management of data access rights" site_url="https://github.com/NielsCharlier/geofence" %}
43+
{% include card_doc_tool.html img_url="/public/icons/ldapadmin_icon.svg" name="Console" text="An administration console for users, roles and organisations" site_url="https://github.com/georchestra/georchestra/tree/master/console" %}
44+
{% include card_doc_tool.html img_url="/public/icons/analytics_icon.svg" name="Analytics" text="A module presenting statistics on use of the platform" site_url="https://github.com/georchestra/analytics" %}
45+
{% include card_doc_tool.html img_url="/public/icons/ldapadmin_icon.svg" name="Mviewer Studio" text="An mviewer application generator" site_url="https://mviewerstudio.readthedocs.io/fr/stable/index.html" %}
46+
</div>

es/documentacion.md

+35-12
Original file line numberDiff line numberDiff line change
@@ -6,19 +6,42 @@ uid: documentation
66
permalink: /es/documentacion.html
77
---
88

9-
La documentación de la instalación y configuratión es ahora parte del repositorio de [código fuente](https://github.com/georchestra/georchestra/), en idioma Inglés.
10-
Puede acceder a ella desde el archivo [README](https://github.com/georchestra/georchestra/blob/master/README.md) en la raíz del proyecto.
9+
<p class="lead">
10+
Desde esta página puede acceder a la documentación de instalación y uso de la plataforma geOrchestra.
11+
</p>
1112

12-
Los **manuales de referencia** de los módulos independientes subyacentes también son valiosas fuentes de información:
13+
<div class="row py-2 d-flex align-items-stretch">
14+
{% include card_doc_tool.html img_url="/favicon.ico" name="geOrchestra" text="Guía de instalación" site_url="https://github.com/georchestra/georchestra/blob/master/docs/index.md" %}
15+
</div>
1316

14-
* En el [sitio web de GeoServer](https://docs.geoserver.org/maintain/en/user/) para la versión 2.20,
15-
* En el [sitio web de GeoNetwork](https://www.geonetwork-opensource.org/manuals/4.0.x/en/) para la versión 4,
16-
* En el [sitio web de GeoWebCache](https://www.geowebcache.org/docs/current/index.html) para la versión 1.16.
17+
## Los componentes de geOrchestra
1718

18-
## Registro OID
19+
### Ver
20+
<div class="row py-2 d-flex align-items-stretch">
21+
{% include card_doc_tool.html img_url="/public/icons/mapstore_icon.svg" name="MapStore2" text="Un visor avanzado de datos geográficos" site_url="https://docs.georchestra.org/mapstore2/" %}
22+
{% include card_doc_tool.html img_url="/public/icons/datafeeder_icon.svg" name="Plugin del registro de la propiedad" text="Un complemento para la consulta del catastro" site_url="https://docs.georchestra.org/cadastrapp/" %}
23+
{% include card_doc_tool.html img_url="/public/icons/mapstore_icon.svg" name="Mviewer" text="Un visor de datos geográficos para el público" site_url="https://mviewerdoc.readthedocs.io/fr/latest/" %}
24+
{% include card_doc_tool.html img_url="/public/icons/datafeeder_icon.svg" name="Plugin de urbanismo" text="Un plugin para consultar documentos de planificación" site_url="https://docs.georchestra.org/mapstore2-urbanisme/fr/latest/" %}
25+
</div>
1926

20-
El proyecto geOrchestra [recibió](https://www.iana.org/assignments/enterprise-numbers/enterprise-numbers)
21-
un *Object Identifier* (OID): `1.3.6.1.4.1.53611`. Es particularmente util para
22-
para manejar los objetos LDAP específicos a geOrchestra. Por debajo de este OID
23-
raíz, la comunidad geOrchestra administra su propio
24-
[registro OID]({{ site.baseurl }}{% link oid.md %}) (en inglés).
27+
### Suministro
28+
<div class="row py-2 d-flex align-items-stretch">
29+
{% include card_doc_tool.html img_url="/public/icons/datafeeder_icon.svg" name="Datafeeder" text="Un asistente de integración de datos" site_url="https://georchestra-user-guide.readthedocs.io/en/latest/setup/datafeeder/" %}
30+
</div>
31+
32+
### Publicar
33+
<div class="row py-2 d-flex align-items-stretch">
34+
{% include card_doc_tool.html img_url="/public/icons/geonetwork_icon.svg" name="GeoNetwork" text="Un catálogo de metadatos" site_url="https://geonetwork-opensource.org/manuals/3.12.x/fr/" %}
35+
{% include card_doc_tool.html img_url="/public/icons/datafeeder_icon.svg" name="GeoServer" text="Un servidor de datos geográficos que cumple las normas WxS del OGC" site_url="https://docs.geoserver.org/stable/en/user/" %}
36+
{% include card_doc_tool.html img_url="/public/icons/geowebcache_icon.svg" name="GeoWebCache" text="Un servidor de azulejos" site_url="https://www.osgeo.org/projects/geowebcache/" %}
37+
{% include card_doc_tool.html img_url="/public/icons/geowebcache_icon.svg" name="Data API" text="Una API de datos abierta que cumple las nuevas normas 'Features API' del OGC" site_url="https://github.com/georchestra/data-api" %}
38+
</div>
39+
40+
### Administrar
41+
<div class="row py-2 d-flex align-items-stretch">
42+
{% include card_doc_tool.html img_url="/public/icons/geofence_icon.svg" name="GeoFence" text="Un módulo para la gestión avanzada de los derechos de acceso a los datos" site_url="https://github.com/NielsCharlier/geofence" %}
43+
{% include card_doc_tool.html img_url="/public/icons/ldapadmin_icon.svg" name="Console" text="Una consola de administración para usuarios, funciones y organizaciones" site_url="https://github.com/georchestra/georchestra/tree/master/console" %}
44+
{% include card_doc_tool.html img_url="/public/icons/analytics_icon.svg" name="Analytics" text="Un módulo que presenta estadísticas sobre el uso de la plataforma" site_url="https://github.com/georchestra/analytics" %}
45+
{% include card_doc_tool.html img_url="/public/icons/ldapadmin_icon.svg" name="Mviewer Studio" text="Un generador de aplicaciones mviewer" site_url="https://mviewerstudio.readthedocs.io/fr/stable/index.html" %}
46+
{% include card_doc_tool.html img_url="/public/icons/ldapadmin_icon.svg" name="Mviewer Studio" text="Un generador de aplicaciones mviewer" site_url="https://mviewerstudio.readthedocs.io/fr/stable/index.html" %}
47+
</div>

fr/documentation.md

+34-12
Original file line numberDiff line numberDiff line change
@@ -6,19 +6,41 @@ uid: documentation
66
permalink: /fr/documentation.html
77
---
88

9-
La documentation d'installation et de configuration est centralisée sur le [dépôt du code source](https://github.com/georchestra/georchestra/), en langue anglaise.
10-
Vous pouvez y accéder depuis le fichier [README](https://github.com/georchestra/georchestra/blob/master/README.md) à la racine du projet.
9+
<p class="lead">
10+
Depuis cette page accédez à la documentation d'installation et d'utilisation de la plateforme geOrchestra.
11+
</p>
1112

12-
Par ailleurs, il est toujours utile de consulter les **documentations publiques** de référence des différents projets communautaires sous-jacents:
13+
<div class="row py-2 d-flex align-items-stretch">
14+
{% include card_doc_tool.html img_url="/favicon.ico" name="geOrchestra" text="Guide d'installation" site_url="https://github.com/georchestra/georchestra/blob/master/docs/index.md" %}
15+
</div>
1316

14-
* sur le [site de GeoServer](https://docs.geoserver.org/maintain/en/user/) pour la version 2.20,
15-
* sur le [site de GeoNetwork](https://www.geonetwork-opensource.org/manuals/4.0.x/en/) pour la version 4,
16-
* sur le [site de GeoWebCache](https://www.geowebcache.org/docs/current/index.html) pour la version 1.16.
17+
## Les différents composants de geOrchestra
1718

18-
## Registre OID
19+
### Visualiser
20+
<div class="row py-2 d-flex align-items-stretch">
21+
{% include card_doc_tool.html img_url="/public/icons/mapstore_icon.svg" name="MapStore2" text="Un visualiseur de données géographiques avancé" site_url="https://docs.georchestra.org/mapstore2/" %}
22+
{% include card_doc_tool.html img_url="/public/icons/datafeeder_icon.svg" name="Plugin Cadastre" text="Un plugin pour la consultation du cadastre" site_url="https://docs.georchestra.org/cadastrapp/" %}
23+
{% include card_doc_tool.html img_url="/public/icons/mapstore_icon.svg" name="Mviewer" text="Un visualiseur de données géographiques destiné au grand public" site_url="https://mviewerdoc.readthedocs.io/fr/latest/" %}
24+
{% include card_doc_tool.html img_url="/public/icons/datafeeder_icon.svg" name="Plugin Urbanisme" text="Un plugin pour la consultation des documents d'urbanisme" site_url="https://docs.georchestra.org/mapstore2-urbanisme/fr/latest/" %}
25+
</div>
1926

20-
Le projet geOrchestra [a reçu](https://www.iana.org/assignments/enterprise-numbers/enterprise-numbers)
21-
un *Object Identifier* (OID): `1.3.6.1.4.1.53611`. C'est particulièrement utile
22-
pour gérer les objets LDAP spécifiques à geOrchestra. Sous ce OID racine, la
23-
communauté geOrchestra administre son propre
24-
[registre OID]({{ site.baseurl }}{% link oid.md %}) (en anglais).
27+
### Fournir
28+
<div class="row py-2 d-flex align-items-stretch">
29+
{% include card_doc_tool.html img_url="/public/icons/datafeeder_icon.svg" name="Datafeeder" text="Un assistant d'intégration des données" site_url="https://georchestra-user-guide.readthedocs.io/en/latest/setup/datafeeder/" %}
30+
</div>
31+
32+
### Publier
33+
<div class="row py-2 d-flex align-items-stretch">
34+
{% include card_doc_tool.html img_url="/public/icons/geonetwork_icon.svg" name="GeoNetwork" text="Un catalogue de métadonnées" site_url="https://geonetwork-opensource.org/manuals/3.12.x/fr/" %}
35+
{% include card_doc_tool.html img_url="/public/icons/datafeeder_icon.svg" name="GeoServer" text="Un puissant serveur de données géographiques respectant les standards WxS de l'OGC" site_url="https://docs.geoserver.org/stable/en/user/" %}
36+
{% include card_doc_tool.html img_url="/public/icons/geowebcache_icon.svg" name="GeoWebCache" text="Un serveur de tuiles" site_url="https://www.osgeo.org/projects/geowebcache/" %}
37+
{% include card_doc_tool.html img_url="/public/icons/geowebcache_icon.svg" name="Data API" text="Une API open data respectant les nouveaux standards 'Features API' de l'OGC" site_url="https://github.com/georchestra/data-api" %}
38+
</div>
39+
40+
### Administrer
41+
<div class="row py-2 d-flex align-items-stretch">
42+
{% include card_doc_tool.html img_url="/public/icons/geofence_icon.svg" name="GeoFence" text="Un module de gestion avancée des droits d’accès aux données" site_url="https://github.com/NielsCharlier/geofence" %}
43+
{% include card_doc_tool.html img_url="/public/icons/ldapadmin_icon.svg" name="Console" text="Une console d’administration des utilisateurs, rôles et organismes" site_url="https://github.com/georchestra/georchestra/tree/master/console" %}
44+
{% include card_doc_tool.html img_url="/public/icons/analytics_icon.svg" name="Analytics" text="Un module présentant les statistiques d’utilisation de la plateforme" site_url="https://github.com/georchestra/analytics" %}
45+
{% include card_doc_tool.html img_url="/public/icons/ldapadmin_icon.svg" name="Mviewer Studio" text="Un générateur d'applications mviewer" site_url="https://mviewerstudio.readthedocs.io/fr/stable/index.html" %}
46+
</div>

0 commit comments

Comments
 (0)