Conference Presentation (Other)

FZJ-2018-03665

http://join2-wiki.gsi.de/foswiki/pub/Main/Artwork/join2_logo100x88.png An easy way to create a website for scientific software project

Pospelov, G. (Corresponding author)FZJ*

2018

Abstract: No one likes creating documentation or investing time in a good looking web site, but everyone enjoys the benefits that come from having appropriate documentation and professionally looking project pages.A big software development team is not limited to the people who actually write and test the code. There are technical writers, marketting specialists, web designers and many more.In scientific software development we don't have such a luxury and have to find a way to createand maintain the online user documentation using only very limited resources.In the BornAgain team we are writing documentation using 'markdown' and generate static htmlof the web site using the Hugo static site generator and the Bootstrap front-end component library.Developers are modifying site content and updating the documentation by modifying markdown files and providing pull requests to the web site repository.The generation of the web site html and the update of the hosting service is going on behind the scenes thanks toGitHub based continuous integration magic, Hugo and the documentation theme developed in our group.We advertise our Hugo based documenting workflow and our dedicated documentation themeas a tool to create modern, good looking, responsive web sites for documenting scientific software projects.

Keyword(s): Instrument and Method Development (1st) ; Instrument and Method Development (2nd)

---

Contributing Institute(s):

1. JCNS-FRM-II (JCNS (München) ; Jülich Centre for Neutron Science JCNS (München) ; JCNS-FRM-II)
2. Neutronenstreuung (Neutronenstreuung ; JCNS-1)
3. Streumethoden (JCNS-2)

Research Program(s):

1. 6G15 - FRM II / MLZ (POF3-6G15) (POF3-6G15)
2. 6G4 - Jülich Centre for Neutron Research (JCNS) (POF3-623) (POF3-623)

Experiment(s):

1. SCG: Scientific Computing Group

Appears in the scientific report 2018

---