Set up as Mkdocs-material site

[GFA-DIU]

Goals

• [x] Set-up as mkdocs material.
• [x] Move content back from Word to markdown.
• [x] Set-up basic structure file structure: separate files ~and load into index~
• [ ] ~Created satisfying design~
• [ ] ~Link to GitHub repo and explain contributions~
• [ ] ~Add data protection information~
• [ ] ~Create deployment to GDPR-compliant server~
• [ ] ~Decide on GDPR-compliant server (e.g. existing GFA Hostinger server)~
• [ ] ~Move incomplete elements from the Word file into issues (i.e. budget lines table, implementation checklist)~

Bonus

• [ ] ~Create CI for style enforcement~

Good resource: MkDocs Material Boilerplate

[GFA-DIU]

On a side note, this syntax seems to work to create dropdowns 😄

This is shown

This is how you dropdown.

<details>
<summary>This is shown</summary>
<br>
This is how you dropdown.
</details>

And "admonitions" also seem to be available easily here

[fretchen]

Very nice.

PR versus issues

I am a bit hesitant to modify things directly in the PR so I will mostly comment and then we can decide if those points should be fixed within this PR or simply in separate issues. Most of the issues above are IMHO things that should be fixed for a release and become issues. If this is fine I would simply create such issues.

file structure

I think that we should really split the main file into the files:

Disclaimer Introduction Essential terminology Checklists at Pre-Project Stage

Then I am happy to modify directly in the files. As for the legal note I think that we should "simply" add a paragraph to the readme, but we could have it at an extra doc too.

layout

I am sadly well aware that my aestethic skills is not quite at par with my technical skills. So take everything with a grain of salt here. Would be really interesting to get feedback from professionell UX designers on this one day...

• I am not sure about the nav bar on top, but without strong opinions.
• I like the table of content on the right.
• I am personally a fan of giscus.

[GFA-DIU]

on PR vs. issues: I'm also happy to work in issues, so let's go ahead with that 😊

file structure:

• absolutely, @fretchen could you quickly take care of that in this PR? This would in my opinion then complete the set-up and we could merge. (I tried to quickly google it but couldn't see how to separate files without creating new pages. )
• Legal notice: I don't think that having it in the README will be enough. Once we have finalized the components of the MVP we can let our data protection officers check I guess.

layout:

• I implemented the right-hand table of contents and, in turn, moved the navigation to the left.
• Giscus: yes, I like it. Should be different from the "gravatar" discussion on wordpress since the entire comment functionality is in Github, I believe.
• UX design: yes, a designer would be nice 😄 but given what we have I can try my hand at drafting something reasonably nice for the MVP. There is an entire discussion on custom homepages, but that seems like a little too much effort right now. 😅

[fretchen]

You can see now how the pages are split into different parts. I do not think that you can load them all into the index page:

• but the navigation on the side should take care of the most some issues.
• I added the arrows at the end to make the jump the next section easier.

Feel free to tell me if this is fine and we are ready to merge for the moment...

[pcschreiber1]

Roger, that's fine for me for now. We will probably pick this up again anyways when drafting the first design. Ready to merge from my side.