description |
---|
En plus de d'écrire du contenu documentaire avec Gitbook, allez encore plus loin et proposez une version interactive de vos tutoriels grâce à des notebooks Jupyter ou bien des tutoriels learnr. |
La méthode certainement la plus simple est d'héberger votre notebook Jupyter sur une plateforme git
telle que GitHub ou GitLab.
Vous pouvez prendre comme exemple le dépôt de Jean-Michel Bernabotto suivant : https://github.com/jmbernabotto/MachineLearning. Dans votre dépôt, déclarez vos dépendances dans le fichier requirements.txt
Puis ajoutez un script qui sera exécuté au lancement du serveur Jupyter sur la plateforme Onyxia : vous pouvez modifier le script onyxia.sh
que vous trouverez dans ce dépôt.
Ensuite, rendez-vous dans le catalogue de service d'Onyxia, sélectionnez le service Jupyter et dans les configurations avancée, dans l'onglet Init
, collez l'URL vers le script de lancement que vous venez d'écrire. oyez bien vigilants à utiliser une URL de type raw vers votre script. Par exemple, avec le dépôt ci-dessus, l'URL est https://raw.githubusercontent.com/jmbernabotto/MachineLearning/master/onyxia.sh.
Vous pouvez alors copier le lien en cliquant sur l'icône en haut à droite et le conserver pour permettre un accès direct à votre formation. Maintenant rendez visible et accessible votre tutoriel au sein de la communauté SSP Cloud:
{% content-ref url="referencer-son-contenu-sur-le-site-sspcloud.fr.md" %} referencer-son-contenu-sur-le-site-sspcloud.fr.md {% endcontent-ref %}
learnr
est un package R qui permet de concevoir facilement des tutoriels interactifs en R Markdown. Si vous ne le connaissez pas, n'hésitez pas à consulter l'aide : https://rstudio.github.io/learnr.
Comme précédemment, le plus simple est d'héberger votre projet RStudio comprenant votre tutoriel sur GitHub ou GitLab. Vous pouvez prendre exemple sur le dépôt de démonstration suivant : https://github.com/RLesur/learnr-onixya. Dans votre dépôt, déclarez vos dépendances dans le fichier DESCRIPTION
et rajoutez un script qui sera exécuté au lancement du serveur RStudio sur la plateforme Onyxia : vous pouvez modifier le script onyxia.sh
que vous trouverez dans ce dépôt.
Ensuite, rendez-vous dans le catalogue de service d'Onyxia, sélectionnez le service RStudio et dans l'onglet Init
collez l'URL vers le script de lancement.
Soyez bien vigilants à utiliser une URL de type raw vers votre script. Avec le dépôt précédent, l'URL est https://raw.githubusercontent.com/RLesur/learnr-onixya/master/onyxia.sh.
Vous pouvez alors copier le lien en cliquant sur l'icône en haut à droite et le conserver pour permettre un accès direct à votre formation. Maintenant rendez visible et accessible votre tutoriel au sein de la communauté SSP Cloud:
{% content-ref url="referencer-son-contenu-sur-le-site-sspcloud.fr.md" %} referencer-son-contenu-sur-le-site-sspcloud.fr.md {% endcontent-ref %}