Repositorio DCAT-AP-ES

Este proyecto proporciona una serie de recursos para la implementación técnica de DCAT-AP-ES, un perfil de aplicación del vocabulario de catálogo de datos (DCAT-AP) para España.

Tip

La documentación disponible en DCAT-AP-ES Online está diseñada para servir como referencia tanto para publicadores como para usuarios de datos abiertos. En ella se detallan los principios y directrices para estructurar y describir conjuntos de datos de acuerdo con el perfil de aplicación DCAT-AP-ES, facilitando su interoperabilidad y reutilización. Además, incluye esquemas de metadatos, ejemplos prácticos, y guías de implementación que ayudan a garantizar una correcta adopción del perfil.

Estructura del Proyecto

El proyecto está organizado de la siguiente manera:

• .devcontainer: Configuración para Dev Containers, una funcionalidad que permite desarrollar en un entorno preconfigurado dentro de un contenedor Docker.
• .github/workflows/: Contiene los flujos de trabajo de GitHub Actions para la generación de la documentación online.
• docs/: Documentación principal del proyecto en formato Markdown para MKDocs.
• overrides: Plantillas personalizadas para la documentación online.
• examples/: Ejemplos de uso de DCAT-AP-ES.
• refs/: Referencias adicionales y documentación relacionada.
• tools/: Herramientas y software útil para la gestión del proyecto. Más información

Contribución

Si deseas contribuir a este proyecto, por ejemplo arreglando algún fichero de validación SHACL de DCAT-AP-ES, por favor sigue estos pasos:

1. Bifurca el repositorio datosgobes/DCAT-AP-ES.

   git clone https://github.com/datosgobes/DCAT-AP-ES.git

2. Crea una nueva rama con tu correción

   git checkout -b fix/shacl-property-x

3. Realiza tus cambios y haz commit

   git commit -am 'Corregido rango de propiedad x'

4. Sube tus cambios

   git push origin fix/shacl-property-x

5. Abre una Solicitud de extracción (Pull Request) para confirmar el cambio en la rama principal.

Desarrollo

Para previsualizar la documentación con MkDocs y lanzarlo en modo depuración, revisa la siguiente documentación: información sobre MKDocs

Traducción de la documentación

Esta documentación usa mkdocs-static-i18n para ser multilingüe, con ese objetivo se adopta la estructura de sufijos:

├── assets
│   ├── css
│   └── js
├── img
├── conventions.en.md
├── conventions.md
├── examples.en.md
├── examples.md
├── index.md
└── robots.txt

Note

Usando la estructura de sufijo en los archivos de documentación (por defecto), debes agregar el sufijo .<idioma>.<extensión> a tus archivos (por ejemplo, index.en.md).
Más información en: Documentación del plugin MkDocs static i18n

Herramientas adicionales del repositorio

1. Python hook (dcat_ap_es.py):

   • Es un hook para MkDocs que se ejecuta después de la construcción del sitio
   • Se encarga de copiar archivos PDF desde un directorio de origen a un directorio de destino en el sitio generado

2. Imagen personalizada para Asciidoctor (Dockerfile):

   • Basado en la imagen asciidoctor/docker-asciidoctor
   • Se utiliza para generar documentos PDF maquetados a partir de archivos AsciiDoc

3. Imagen personalizada para md2adoc (Dockerfile):

   • Basado en la imagen ruby
   • Se utiliza para convertir documentos Markdown a formato AsciiDoc

Estos tres componentes forman parte de un pipeline de documentación que:

1. Convierte archivos Markdown a AsciiDoc (usando el contenedor md2adoc)
2. Genera PDF a partir de los archivos AsciiDoc (usando el contenedor asciidoctor)
3. Copia los PDF generados al sitio web final durante la construcción de MkDocs (usando el hook de Python)

Licencia

Todo el material de este repositorio se publica bajo la licencia CC-BY 4.0, a menos que se mencione explícitamente lo contrario. Consulta el archivo LICENSE para más detalles.

Contacto

Para cualquier consulta o sugerencia, por favor abre una incidencia (Issue) en el repositorio o contacta a los mantenedores del proyecto.