oceanhackweek / oceanhackweek/oceanhackweek.github.io

Use ReadTheDocs

Abierto
#249 2 comentarios 0 reacciones 0 asignados Ver en GitHub

Nadie ha tomado este issue todavía.

Lenguaje dominante
CSS
Estrellas
12
Forks
49
Merge medio
19 min
PR fusionados (30 d)
1

Descripción

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

Guía de contribución

No hay ninguna guía de contribución indexada para este repositorio

Primeros pasos

  1. Lee el issue completo y luego la guía de contribución del proyecto.
  2. Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
  3. Haz un fork del repositorio y trabaja en una rama.
  4. Abre un pull request que haga referencia al número del issue.

Línea de trabajo

Empieza revisando la configuración actual de GitHub Pages y Netlify; después, lee la discusión anterior en #237 y la documentación enlazada de ReadTheDocs sobre Conda, post_build y single-version mode. La tarea se consideraría completada cuando exista un plan de migración acordado que cubra las compilaciones, las vistas previas de PR y los sitios antiguos existentes; no se menciona ningún archivo de implementación ni ninguna prueba.

Escrito por el modelo de indexación a partir del texto del issue.

Evaluación

Stack tecnológico
anaconda, github
Área
devops, documentation
Tipo de issue
Nueva funcionalidad
Dificultad
5/5
Tiempo estimado
Más de una semana
Estado de actividad
Estancado
Claridad
Necesita aclaración
Aptitud para principiantes
25/100

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.