Development guidelines for contributors to the MIP platform
The site is built from Markdown content using Hugo to generate the HTML code.
Development is done on the master branch of this repository, HTML pages should go to the gh-pages branch.
To get started, type the following in a command line. You will need Git version 2.7 or better and Docker.
git clone git@github.com:HBPMedical/development-guidelines
cd development-guidelines
./after-git-clone.sh
This will create the folder development-guidelines.pages that contains the HTML pages to be published on Github.io.
Use the following command to run Hugo as a local server, available on localhost:1313. Any change you do on Markdown files will be updated immediately in the local site.
./run.sh
Commit regularly your changes, ideally indicating what what changed, for example
git commit -a -m "Add new User Documentation page"
When you are ready to publish, follow those steps:
# commit all your work
git add --all .
git commit -m "<My changes>"
git push
# build and publish the new site
./publish.sh
Done.
You can use the following services to contribute to the site:
Please be careful when publishing your changes back to Github.