Skip to content

Search is only available in production builds. Try building and previewing the site to test it out locally.

Contributing with Gerrit

All Euodos code and this wiki are versioned in Git and reviewed with Gerrit. There are no pull requests: every change is a patch set submitted for review.

  1. Create a Gerrit account and add your SSH key under Settings → SSH keys.

  2. Clone the repository:

    Terminal window
    git clone "ssh://<username>@gerrit.example.org:29418/euodos-wiki"
    cd euodos-wiki
  3. Install the commit-msg hook, which automatically adds a Change-Id to every commit:

    Terminal window
    gitdir=$(git rev-parse --git-dir)
    scp -p -P 29418 <username>@gerrit.example.org:hooks/commit-msg "${gitdir}/hooks/"
  4. (Optional) Install git-review to simplify pushing.

  1. Create a local branch from main:

    Terminal window
    git checkout -b my-change origin/main
  2. Edit the files, then commit:

    Terminal window
    git commit -a

    Follow the commit conventions.

  3. Send the change for review:

    Terminal window
    git push origin HEAD:refs/for/main
    # or, with git-review:
    git review
  4. Gerrit prints the change URL. Reviewers comment on it and vote.

  5. To address feedback, amend the commit and push again:

    Terminal window
    git commit -a --amend --no-edit
    git push origin HEAD:refs/for/main

    The same Change-Id creates a new patch set on the same change.

Vote Meaning
Code-Review +2 Approved by a maintainer
Code-Review +1 Looks good, but cannot merge
Code-Review -1 Changes requested
Verified +1 CI (wiki build) passed

A maintainer clicks Submit once the change has Code-Review +2 and Verified +1.

  • Directorysrc
    • Directorycontent
      • Directorydocs
        • Directoryen
          • overview
          • installation
          • devices
          • usage
          • development
          • reference
          • brand
        • Directoryfr
          • overview
          • …
    • Directorystyles
      • custom.css
    • assets
  • astro.config.mjs
  • package.json

English pages live in docs/en/, French translations in docs/fr/, with the same tree.

Terminal window
npm install
npm run dev

The site is then available at http://localhost:4321. Check the build before pushing:

Terminal window
npm run build