-
Notifications
You must be signed in to change notification settings - Fork 58
Open
Labels
CHECK_LABELLabels needs to be checked by a humanLabels needs to be checked by a humanHackathon ProjectProject suggestionProject suggestiondocumentationImprovements or additions to documentationImprovements or additions to documentationproject_type:documentation
Description
Learning how to publish your work online
Project Description
The main goal is to learn how to make your work available to the world online. This can include, e.g.,
- learning how to create your own personal website where you can tell the world more about yourself and host information about your work
- learning how to create web-pages for your projects where you can display documentation, analysis code, results, etc.
- relatedly, how to render jupyter-notebooks or RMarkdown scripts so that they can be displayed online
- learning how to create a documentation, e.g. using ReadTheDocs, for a specific project / piece of software you developed
Skills required to participate
I guess, none of the skills listed below are necessary required but can come in handy:
- some basic knowledge of
gitcould be useful, since one way of hosting (static) websites can be done through github pages - basic shell / bash knowledge could be useful, e.g., to navigate local git repositories etc.
- maybe some html or javascript knowledge could be useful
ideally, it would be very helpful if at least one person would join who knows these things well to give help and could answer questions, etc.
Integration
The main goal could be to create (1) an example project website using github pages, (2) display rendered example analysis code on this website and (3) write a project documentation using e.g., Read The Docs
Preparation material
tba, if someone knows helpful resources please post them here, thanks
Communication
tba
Metadata
Metadata
Assignees
Labels
CHECK_LABELLabels needs to be checked by a humanLabels needs to be checked by a humanHackathon ProjectProject suggestionProject suggestiondocumentationImprovements or additions to documentationImprovements or additions to documentationproject_type:documentation