Skip to content

Latest commit

 

History

History
82 lines (56 loc) · 3.83 KB

README.en.md

File metadata and controls

82 lines (56 loc) · 3.83 KB

DCAT-AP-ES repo

EN ES

This project provides a set of resources for the technical implementation of DCAT-AP-ES, an application profile of the Data Catalog Vocabulary (DCAT-AP) for Spain.

Tip

The documentation available at DCAT-AP-ES Online is intended as a reference for both data publishers and users of open data. It details the principles and guidelines for structuring and describing datasets according to the DCAT-AP-ES Application Profile, facilitating their interoperability and reuse. It also includes metadata schemas, practical examples, and implementation guidelines to help ensure proper adoption of the profile.

Project Structure

The project is organized as follows:

  • .devcontainer: Configuration for Dev Containers, a feature that allows development in a pre-configured environment within a Docker container.
  • .github/workflows/: Contains GitHub Actions workflows for generating the online documentation.
  • docs/: Main project documentation in Markdown format for MKDocs.
  • overrides: Custom templates for the online documentation.
  • examples/: Usage examples of DCAT-AP-ES.
  • refs/: Additional references and related documentation.
  • tools/: Tools and useful software for project management.

Contribution

If you want to contribute to this project, for example by fixing a SHACL validation file of DCAT-AP-ES, please follow these steps:

  1. Fork the datosgobes/DCAT-AP-ES repository.

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

  2. Create a new branch with your fix

    git checkout -b fix/shacl-property-x

  3. Make your changes and commit them:

    git commit -am 'Fixed range of property x'

  4. Push your changes:

    git push origin fix/shacl-property-x

  5. To commit the change to the main branch, open a Pull Request(https://github.com/datosgobes/DCAT-AP-ES/pulls).

Development

To preview the documentation with MkDocs and launch it in debug mode, check the following documentation: Information about MkDocs.

Translation

This documentation uses mkdocs-static-i18n to support multiple languages. To achieve this, the suffix structure is adopted:

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

Note

When using the suffix structure for documentation files (default), you must add the suffix .<language>.<extension> to your files (e.g., index.en.md).
More information at: MkDocs static i18n plugin documentation

License

All material in this repository is published under the licence CC-BY 4.0, unless explicitly otherwise mentioned. See the LICENSE file for more details.

Contact

For any questions or suggestions, please open an Issue in the repository or contact the project maintainers.