Skip to content

InseeFrLab/funcamp.sspcloud.fr

Repository files navigation


Regarding the Funcamp project in general.

This repo is the source code of the funcamp.sspcloud.fr website.
Inside the docs/ are the sources for the documentation website docs.funcamp.sspcloud.fr.

Index of the rest of the project's source code:

Repository Description
funcamp-r-grimoire R (learnr) tutorials
funcamp-r-dock Base docker image for learnr tutorials
funcamp-r-neverending Last chapter
funcamp-r-icarius Serious game (requires the Solarus Game Engine)
funcamp-r-ubuntu-solarus Docker image of ubuntu-desktop-lxde-vnc including the Solarus Game Engine
funcamp-r-windows-solarus Zip archive to run the icaRius game on Windows
funcamp-r-windows-grimoire-launcher Ressources to set up a local drive with all the resources for Windows

Contributing to funcamp.sspcloud.fr

funcamp.sspcloud.fr is a react app.
The code on this repo (docs/ folder set aside) is the source code of the website.

First thing, if you are not collaborator, is to fork the repo:
image

Then

git clone https://github.com/InseeFrLab/funcamp.sspcloud.fr #If you have forked the repo use your username in place of InseeFrLab in the url.
cd funcamp.sspcloud.fr
yarn #Equivalent of npm install

#...Make the changes you want to make...

yarn start

#...Test your changes...

If everything looks good, you can submit a pull request

git checkout -b my_changes
git add -A
git commit -am "My changes"
git push origin my_changes

The come back here (https://github.com/InseeFrLab/funcamp.sspcloud.fr), GitHub will automatically suggest you open a PR.

The changes on the default branch (main) are published automatically on funcamp.sspcloud.fr using github action. See workflow here: deploy.yaml

More info, for those who want to understand what is going on behind the scenes.

funcamp.sspcloud.fr is hosted here on github using github pages.
If you go over to the Settings page of this repo and scroll down, you will find:
image This means that everything published on the gh-pages branch of this repo is public at funcamp.sspcloud.fr.

There is a script setup that takes the build folder and publish it over to gh-page all you have to do is run:

yarn run deploy

NOTE: With use git LFS to avoid tracking the assets (images and vieos)

image

Contributing to docs.funcamp.sspcloud.fr

The documentation website is not hosted via github page but with gitbook.com the easier way to contribute to the documentation is to request access to the GitBook space to one of the maintainers by opening an issue.

Once logged in you will get access to a full editor, no need to mess around with the code 😉
image

The sources for the pages, however, are synced bidirectionally in the docs/ folder. In consequence it is also possible to modify directly, the markdown (.md) files in the docs/ folder directly, the changes will be published automatically.

For publishing translation or new version of the documentation without suppressing the previous one, there is the variation feature of gitbook