This project generates the static User Documentation site for the Open Science Portal. It is created and maintained by the Open Science Branch of Fisheries and Oceans Canada.
Access the documentation here: https://osp-pso-docs.ent.dfo-mpo.ca/
If you notice grammatical errors or inaccuracies in the documentation, please report them through one of the following methods:
- GitHub Issues: Submit an issue directly in the repository.
- Email: Contact the OSP Support Team.
The project's code, including configuration files and VuePress 2 components, is licensed under the MIT License. You are free to use, modify, and distribute the code under the terms of this license.
The site’s content is protected by Government of Canada Crown Copyright. Unless otherwise stated, content is licensed under the Open Government Licence – Canada.
Ensure you have the following tools installed to build the documentation site:
- Node.js v18.19.0+ — A JavaScript runtime used to run
pnpmand build the VuePress site. - pnpm v9.4.0+ — A fast, disk space-efficient package manager.
- Clone repository onto local machine
git clone git@github.com:dfo-osdt/osp-docs.git- Change into
osp-docsdirectory and install dependencies
cd ./osp-docs
pnpm install- Build the site
pnpm docs:build- Build the on-boarding map
pnpm docs:map- Start the local development server
pnpm docs:devThe version of VuePress can be updated by running the updater script (included in this project)
pnpm dlx vp-update-
Update the status conditions in
/docs/.vuepress/public/data/onboarding.en.jsonand/docs/.vuepress/public/data/onboarding.fr.json -
Rebuild the map
pnpm docs:map"scripts": {
"docs:dev": "vuepress dev docs",
"docs:build": "vuepress build docs",
"docs:dev-clean": "vuepress dev docs --clean-cache --clean-temp",
"docs:map": "DFO_NAME_FIELD=Region_EN node ./docs/.vuepress/scripts/geojson-to-dfo-svg.mjs",
"docs:update": "pnpm dlx vp-update"
}All changes must be done via a PR to the main branch. PR should be descriptive and provide
reference to any issues as required.
For commits, messages, use Conventional Commits
The commit message should be structured as follows:
<type>[optional scope]: <description>
[optional body]
[optional footer(s)]
[
'build',
'chore',
'ci',
'docs',
'feat',
'fix',
'perf',
'refactor',
'revert',
'style',
'test'
]- VuePress 2 - A static site generator powered by Vue.js 3, used for building the documentation site.
- Vue.js 3 - The progressive JavaScript framework that powers VuePress 2.
- Markdown - A lightweight markup language with plain text formatting syntax, used for writing the documentation content.
- JavaScript/TypeScript
- For scripting and building custom features or plugins within the VuePress site.
Ce projet génère le site de documentation utilisateur statique pour le Portail de la science ouverte. Il est créé et maintenu par la Direction de la science ouverte de Pêches et Océans Canada.
Accédez à la documentation ici : https://osp-pso-docs.ent.dfo-mpo.ca/
Si vous remarquez des erreurs grammaticales ou des inexactitudes dans la documentation, veuillez les signaler par l’un des moyens suivants :
- GitHub Issues : Soumettez un problème directement dans le dépôt.
- Courriel : Contactez l’équipe de soutien du PSO.
Le code du projet, y compris les fichiers de configuration et les composants VuePress 2, est sous licence MIT. Vous êtes libre d’utiliser, de modifier et de distribuer le code selon les termes de cette licence.
Le contenu du site est protégé par le droit d’auteur de la Couronne du gouvernement du Canada. Sauf indication contraire, le contenu est sous licence Licence du gouvernement ouvert – Canada.
Assurez-vous d’avoir les outils suivants installés pour compiler le site de documentation :
- Node.js v18.19.0+ — Un environnement d’exécution JavaScript
utilisé pour exécuter
pnpmet compiler le site VuePress. - pnpm v9.4.0+ — Un gestionnaire de paquets rapide et efficace en espace disque.
- Clonez le dépôt sur votre machine locale
git clone git@github.com:dfo-osdt/osp-docs.git- Accédez au répertoire
osp-docset installez les dépendances
cd ./osp-docs
pnpm install- Compilez le site
pnpm docs:build- Construire la carte d’intégration
pnpm docs:map- Démarrez le serveur de développement local
pnpm docs:devLa version de VuePress peut être mise à jour en exécutant le script de mise à jour (inclus dans ce projet).
pnpm dlx vp-update-
Mettre à jour les conditions d’état dans /docs/.vuepress/public/data/onboarding.en.json et /docs/.vuepress/public/data/onboarding.fr.json.
-
Reconstruire la carte
pnpm docs:mapToutes les modifications doivent être effectuées via une PR vers la branche main.
Les PR doivent être descriptives et inclure des références aux issues, si nécessaire.
Pour les messages de commit, utilisez Conventional Commits.
Le message de commit doit être structuré comme suit :
<type>[portée optionnelle] : <description>
[corps optionnel]
[pied(s) de page optionnel(s)]
[
'build',
'chore',
'ci',
'docs',
'feat',
'fix',
'perf',
'refactor',
'revert',
'style',
'test'
]- VuePress 2 - Un générateur de site statique alimenté par Vue.js 3, utilisé pour construire le site de documentation.
- Vue.js 3 - Le framework JavaScript progressif qui alimente VuePress 2.
- Markdown - Un langage de balisage léger avec une syntaxe de formatage en texte brut, utilisé pour rédiger le contenu de la documentation.
- JavaScript/TypeScript - Pour les scripts et la création de fonctionnalités ou de plugins personnalisés dans le site VuePress.