The CIOOS Data Management Guide is an MkDocs project that presents the recommended best practices for managing data within the Canadian Integrated Ocean Observing System (CIOOS). This guide is designed to help data managers adopt FAIR (Findable, Accessible, Interoperable, and Reusable) and CARE (Collective Benefit, Authority to Control, Responsibility, and Ethics) principles in their workflows.
- Comprehensive documentation on data management best practices.
- Multilingual support (English and French).
- Visual assets and guides to assist in implementation.
From the actual reference page, you like to work on, click on the Edit link button near the top corner.
This will send you to the repository associated document. Make the desired edits, commit changes to the branch right away.
The changes should be reflected on the live page shortly.
To run and develop the project locally, follow these steps:
-
Clone the repository:
git clone https://github.com/your-repo/cioos-data-management-guide.git cd cioos-data-management-guide -
Install the package manager uv See UV documentation on how to install it within the different environments:
-
Create local environment with UV
uv venv -
Run mkdocs in development mode
uv run mkdocs server -
Apply changes
-
Commit changes and push
For further documentation, refer to the mkdocs-material theme documentation.
We are also using some extensions:
Live web site is made available at: https://cioos-siooc.github.io/cioos-siooc-guide/
We use mike to manage multiple published versions of the site on GitHub Pages.