[INFRA] Automatically update website when new content is added to main repo

[alexandreroutier]

Hi,

MKDocs allows to deploy Wiki on GitHub pages (see https://www.mkdocs.org/user-guide/deploying-your-docs/).

We need to automate this procedure.

I can volunteer for this task :)

Alex

[Remi-Gau]

Awesome. :-) <3

Sounds good.

Will make sure you are admin in case you need to tweak things in the settings of the repo.

[Remi-Gau]

So I have been able to deply on my accout: https://remi-gau.github.io/tutorials-and-resources/programming/

But not yet on upstream it seems: https://learn-neuroimaging.github.io/tutorials-and-resources/

[alexandreroutier]

If you look at the details of the deployment, you will see that MkDocsc built 463a40f commit which is the latest on the master branch. :)

So, should we keep https://learn-neuroimaging.github.io/tutorials-and-resources/ for the moment ?

[Remi-Gau]

If you look at the details of the deployment, you will see that MkDocsc built 463a40f commit which is the latest on the master branch. :) but it did try to deploy it on a gh-pg branch, right?

So, should we keep https://learn-neuroimaging.github.io/tutorials-and-resources/ for the moment ? yeah I think that for now we can keep this one.

[alexandreroutier]

If you look at the details of the deployment, you will see that MkDocsc built 463a40f commit which is the latest on the master branch. :) but it did try to deploy it on a gh-pg branch, right?

Indeed. From what I understand, mkdocs gh-deploy creates a gh-pages branch on the repo. However, it is not automatically updated when a new commit appears on master. When you updated the website today, did you run mkdocs gh-deploy?

I would be interested in finding a way to automatically deploy MkDocs using Jenkins or other solutions (e.g. GitHub Actions). I have never done this before. 🙃

[Remi-Gau]

You are correct I simply, clone the upstream repo and did mkdocs gh-deploy. Worked super quickly.

I wonder if we can do that with Travis as this is what we are using for the markdown linter.

Would be nice to learn how to do that. :-)

[alexandreroutier]

To sum up the Jitsi meeting :

• There are several tools to automate deployment with MkDocs (e.g. Travail, Netflify, etc.). Since we already use Travail for Markdown check, we can consider keeping Travis but this is not compulsory at all.
• We would like to decompose this task into 2 subtasks:
  • Step 1) Check that MkDocs builds the website without issue when someone submit a PR
  • Step 2) Automatically update the website when the PR is merged
• Examples of GitHub projects using MkDocs:
  • "Awesome Python" : https://github.com/vinta/awesome-python / https://awesome-python.com/
  • The BIDS Specifications : https://github.com/bids-standard/bids-specification/ / https://bids-specification.readthedocs.io/

[Remi-Gau]

Added a gthub action that does this for us. :smile: