oceanhackweek / oceanhackweek/oceanhackweek.github.io

Use ReadTheDocs

Ouverte
#249 2 commentaires 0 réactions 0 personnes assignées Voir sur GitHub

Personne n'a encore pris cette issue.

Langage dominant
CSS
Étoiles
12
Forks
49
Merge moyen
19 min
PR mergées (30 j)
1

Description

Currently we're using Github Pages for hosting and Netlify for PR previews. We keep having issues due to Netlify's Python environment, and it's lack of support for Conda making our packages fall out of sync.

ReadTheDocs now supports Conda/Mamba, so we could simplify our environment, and have the same service manage the build and PR previews.

I remember we had some discussion about RTD before, and I can't remember exactly why we didn't use them and instead built our own versioning scheme. Was it due to the advertising? We can opt it out of advertising by someone getting a membership, which I just tried for Xpublish.

To get our existing old sites, we would probably want to tag the desired commits, then use post_build customization to pull those in. The other place to customize might be to use single version mode.

xref: #237 @emiliom @ocefpaf

Guide de contribution

Aucun guide de contribution indexé pour ce dépôt

Par où commencer

  1. Lisez l'issue en entier, puis le guide de contribution du projet.
  2. Signalez en commentaire que vous la prenez — cela évite que deux personnes fassent le même travail.
  3. Forkez le dépôt et travaillez sur une branche.
  4. Ouvrez une pull request qui référence le numéro de l'issue.

Piste de recherche

Commencez par examiner la configuration actuelle de GitHub Pages et Netlify, puis lisez la discussion précédente dans #237 ainsi que la documentation ReadTheDocs liée concernant Conda, post_build et single-version mode. La tâche serait considérée comme terminée lorsqu’un plan de migration convenu couvrant les builds, les aperçus de PR et les anciens sites existants serait défini ; aucun fichier d’implémentation ni test n’est mentionné.

Rédigé par le modèle d'indexation à partir du texte de l'issue.

Évaluation

Stack technique
anaconda, github
Domaine
devops, documentation
Type d'issue
Fonctionnalité
Difficulté
5/5
Temps estimé
Plus d'une semaine
Activité
À l'abandon
Clarté
À clarifier
Accessibilité débutants
25/100

Recevez les nouvelles issues par e-mail

Un résumé court des issues GitHub adaptées aux débutants.