update documention for developers

[martvanrijthoven]

• [ ] create roadmap

Roadmap

• [ ]

[nlessmann]

Related: #219

[JoeySpronck]

@marinadamato @drepeeters please check the full dev docs documentation

Feel free to improve things list uncertain parts or missing parts so we can still ask Mart while he is around

[marinadamato]

• Do we want to have part1, part2, part3 in the same markdown file or do we want to have separate files? I find the documentation's structure confusing.
• Part1:
  • Installation: the instructions related to docker are missing.
  • Content: "Within the copy_content.sh script, the default website pages are copied (such as the home page, 404 and the colofon), the content bib files are copied, and the parse_content.sh script is called which copies only the relevant site specific content to the website folder. Later down the website building pipeline, some of the files of the websites' content folders are generated automatically by --BY WHAT--?." -> what should we add here?
  • Templates: "The html templates provide backbones of the web pages. They contain many jinja placeholders that are filled in automatically when the websites are built. -- NOT SURE HOW THESE ARE USED" -> what should we add here?
  • Static folder:
    1. "See "themese" first -> the "themes" section is empty
    2. This contains some default css and js files -- Not sure how these relate to critical css -> what should we add here?
  • Critical css: "we extract the critical css assets (automatically?)" -> automatically?
  • Websites: where can I find these these pelican_config.py and publish_config.py files?
  • Custom-template, drafts, themes, custom-css, design resources: do we need these parts? And what should we write?
• Part2:
  • Scripts: the same text related to copy_content and parse_content is already present in part1.
  • above-the-fold: "Above the fold content is what is shown to the website viewer when he/she enters our website (without scrolling). -- not sure what we do with this" -> what should we add here?
  • plugins imgutil: is the information correct?
  • plugins inline extend: 'double check how we use this'