Development Guide

This page describes the intricacies of DocDokuPLM development.

Code Convention

To know DocDoku coding convention look at Code Convention.

Git flow for DocDokuPLM and eplmp submodule

Update main project (docdoku-plm)

git pull
git submodule sync --recursive
git submodule update --init --recursive

Change submodule reference in docdoku-plm

cd eplmp
git fetch
git checkout -q <commit-sha1>
cd ..
git commit -m "Update eplmp module ref to <commit-sha1>...."

Making changes in eplmp (commiters of polarsys/eplmp)

# Optionally to switch from https to ssh, issue the command inside eplmp folder: 
git remote set-url origin git@github.com:polarsys/eplmp.git

# Keep up to date
git submodule update --remote --rebase -- eplmp
cd eplmp

# eplmp modifications....

git commit -am "My commit message for eplmp repository ..."
git push origin HEAD:master

# Dont forget to update eplmp reference in docdoku-plm if needed
cd ..
git add eplmp
git commit -m "Update eplmp module ref to xxxxx...."

DocDokuPLM web client

By "DocDokuPLM web client" we mean the web based (HTML UI) front-end. Since DocDokuPLM is a modular platform, the software core engine and the web UI are two distinct components, see the web client development guide