Learning how to publish work online

[lnnrtwttkhn]

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 git could 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

[effigies]

I have some experience with this, particularly with Sphinx + GitHub pages and Sphinx + ReadTheDocs. If that's useful to people, I'm happy to talk. No experience with Rmarkdown.

[lnnrtwttkhn]

That would be great @effigies, thanks! Where / when should we meet?

[SamGuay]

I can help with RMarkdown and rendering it into a github/gitlab website, all automated. With Hugo in RStudio. We should meet tomorrow at breakfast!

[lnnrtwttkhn]

@effigies and I are meeting at Mercato Centrale on 3rd floor in front of the projector screen now at breakfast. feel free to come along!

[josepman]

Hey guys, I was in the traintrack talks. How was it? What about a quick meeting after lunch?

[lnnrtwttkhn]

Hi @josepman, so @effigies gave me a general overview mainly how to set up a documentation with sphinx and ways to deploy it online. yes, we could sit down after lunch and maybe try to get some examples up and running. let's meet at mercato centrale, 3rd floor after lunch. :v:

[emdupre]

:tada: Love this ! Other references of interest are blogdown, radix, and MkDocs ! Happy to talk about any of these.

[josepman]

Cool, thanks! See you later then :)

[lnnrtwttkhn]

Update: @SamGuay and I are on 2nd floor at Mercato Centrale.

[effigies]

For reference, @lnnrtwttkhn and I discussed:

• sphinx-quickstart for building an initial documentation project with Makefile
• sphinx-nbexamples for auto-generating an example gallery from a directory of notebooks (see fitlins/docs/conf.py and fitlins/examples/notebooks)
• Using Makefiles to document/streamline the process of building docs and pushing to GitHub, a la nibabel

[josepman]

Hi @effigies , thanks for the links!

@SamGuay @lnnrtwttkhn do you want to meet this morning and check the progress? :)

[aileinwhells]

Hi I have a very simple question: I put my repository on Github but now i would like to know how to get my website online for everyone to see. Namely my website is my CV.

Salut J'ai une question tout simple : j'ai mis mon référentiel sur Github mais maintenant j'aimerais savoir comment mettre mon site Web en ligne pour qu'il soit vu par tout le monde. A savoir mon site Web est mon CV.