Set up initial documentation
Nadie ha tomado este issue todavía.
Evaluación
- Dificultad
- 5/5
- Tiempo estimado
- Más de una semana
- Aptitud para principiantes
- 20/100
- Tipo de issue
- Documentación
- Claridad
- Necesita aclaración
- Estado de actividad
- Estancado
- Stack tecnológico
- jupyter-notebook, python
- Área
- documentation
Línea de trabajo
Empieza por resolver las tres preguntas del issue: el propósito del repositorio, cómo deben dividirse la documentación y los tutoriales, y si se debe usar MkDocs o mdBook. En el issue no se mencionan archivos ni tests. Se considera completado cuando se hayan acordado el alcance de la documentación, la ubicación de los tutoriales y las herramientas para GitHub Pages.
Escrito por el modelo de indexación a partir del texto del issue.
Descripción
At some point, we will probably want the code and notebooks in this repo to have documentation on GitHub Pages.
We will need to work out a few things before we do that, namely:
- What do we want this repo to be for? Are we going to publish a Python package or is it just example Jupyter notebooks etc.?
- How are we going to divide the documentation between this repo and the main one? Where should tutorials live?
- What tooling do we want to use for this? MkDocs is the obvious choice (there is also a plugin for notebooks), but we could also go with mdBook, as we've done for the main repo, for consistency.
My feeling about 2 is that it probably makes sense to have tutorials in this repository, as we will want to walk users through analysing the data, which will be easier if we embed Jupyter notebooks.
- Lenguaje dominante
- Python
- Estrellas
- 0
- Forks
- 0
- Merge medio
- 8 min
- PR fusionados (30 d)
- 8
Preparar el entorno
- Sin Dockerfile ni archivo de Docker Compose
- Tiene una plantilla de pull request
- Sin guía de contribución
Primeros pasos
- Lee el issue completo y luego la guía de contribución del proyecto.
- Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
- Haz un fork del repositorio y trabaja en una rama.
- Abre un pull request que haga referencia al número del issue.
Más de EnergySystemsModellingLab/muse2_data_analysis
-
Add issue templates/formsQuizá libre de nuevo @alexdewar la tomó hace 156 días y no hay ningún pull request abierto. Abierto
EnergySystemsModellingLab/muse2_data_analysis#59 · 1 asignado ·
Todos los issues de EnergySystemsModellingLab/muse2_data_analysis
Issues similares
-
adr
Dificultad 2/5 1-3 horas Aptitud para principiantes 72/100
kristofdegrave/homeassistant-smart-charging#1607 ·
Los mantenedores suelen responder en 1 día
-
namespace operations
Dificultad 2/5 1-3 horas Aptitud para principiantes 64/100
EclipseFdn/open-vsx.org#13665 ·
Los mantenedores suelen responder en 1 día
-
doc good first issue help wanted
Dificultad 2/5 1-3 horas Aptitud para principiantes 68/100
collective/icalendar#1865 · 2 comentarios ·
Los mantenedores suelen responder en 1 día
-
Dificultad 2/5 1-3 horas Aptitud para principiantes 82/100
canonical/opentelemetry-collector-operator#409 ·
Los mantenedores suelen responder en 1 día
-
Dificultad 1/5 Menos de una hora Aptitud para principiantes 85/100
mozilla/addons-release-tests#1243 ·
Los mantenedores suelen responder en 1 día