OKDP.io

About the Site

This repository contains the source of the okdp.io website, featuring:

• Marketing landing page;
• Documentation;
• i18n (FR/EN) support.

Development

npm install
npm run dev

Build

npm run build
npm run preview

Preview deployments from forks

To let contributors share a live preview without deploying anything in the upstream OKDP organization, the repository includes a fork-only GitHub Actions workflow in .github/workflows/preview.yml.

How it works

• it runs on every push to a non-master branch in a fork
• it publishes the built site to the fork's gh-pages branch under previews/<branch-slug>/
• it is skipped automatically in the upstream OKDP/okdp.io repository
• it removes the production CNAME file before publishing, so a fork preview never tries to claim okdp.io

One-time setup in a fork

1. Fork OKDP/okdp.io
2. In the fork, enable GitHub Actions if prompted
3. In Settings → Pages, configure GitHub Pages to deploy from the gh-pages branch (root)
4. Push your feature branch to the fork

Your preview will then be available at:

https://<fork-owner>.github.io/<fork-repo-name>/previews/<branch-slug>/

When opening a pull request against upstream, you can paste that preview URL into the PR description.

Community

• Organization: TOSIT Association
• Communication: Github discussion