Automatic documentation
Nadie ha tomado este issue todavía.
Evaluación
- Dificultad
- 4/5
- Tiempo estimado
- 3-5 días
- Aptitud para principiantes
- 30/100
- Tipo de issue
- Documentación
- Claridad
- Bastante claro
- Estado de actividad
- Estancado
- Área
- documentation
Línea de trabajo
Comienza revisando la documentación de MkDocs y la implementación de stac-fastapi referenciada; después, inspecciona el repositorio en busca de documentación existente y de la configuración de publicación. Se considera terminado cuando la documentación del proyecto se genera y se publica en un sitio web, probablemente mediante GitHub Pages, y la configuración elegida queda registrada para futuros colaboradores.
Escrito por el modelo de indexación a partir del texto del issue.
Descripción
To assist with adoption & understanding of framework, it would be nice if we had documentation that were auto-generated and published to a website (likely Github Pages).
MkDocs seems like a popular choice (ref: stac-utils/stac-fastapi implementation)
- Lenguaje dominante
- Python
- Estrellas
- 4
- Forks
- 1
- Métricas de merge de PR
- Sin PR fusionados en 30 d
Preparar el entorno
Este proyecto no incluye contenedor de desarrollo, Dockerfile ni guía de contribución, así que la configuración corre por tu cuenta: empieza por su README y consulta nuestra guía para la primera contribución para los pasos generales.
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 developmentseed/ingest-framework
-
Setup lintingAbierto
Dificultad 4/5 3-5 días Aptitud para principiantes 25/100
-
Dificultad 4/5 3-5 días Aptitud para principiantes 38/100
-
Support versioningAbierto
Dificultad 5/5 Más de una semana Aptitud para principiantes 25/100
-
Upgrade to CDK v2Abierto
Dificultad 4/5 3-5 días Aptitud para principiantes 35/100
Todos los issues de developmentseed/ingest-framework
Issues similares
-
wr.dynamodb.read_items returns [{}] for a single partition value that does not existPosiblemente ocupada @auraseb la tomó hoy. Abierto
Dificultad 2/5 1-3 horas Aptitud para principiantes 84/100
aws/aws-sdk-pandas#3520 ·
Los mantenedores suelen responder en 2 días
-
requires triage typing
Dificultad 2/5 1-3 horas Aptitud para principiantes 78/100
sqlalchemy/sqlalchemy#13704 ·
Los mantenedores suelen responder en 1 día
-
Edit tool converts CRLF files to LFPosiblemente ocupada @RaphaelFakhri la tomó hoy. Abierto
Dificultad 2/5 1-3 horas Aptitud para principiantes 68/100
huggingface/tau#774 ·
Los mantenedores suelen responder en 1 día
-
show ignores the row limit when a column or table name contains "limit"Posiblemente ocupada @RaphaelFakhri la tomó hoy. Abierto
Dificultad 2/5 1-3 horas Aptitud para principiantes 88/100
Los mantenedores suelen responder en 1 día
-
What happened to `check.py`?Abierto
Dificultad 2/5 1-3 horas Aptitud para principiantes 67/100
linebender/resvg#1179 · 1 comentario ·
Los mantenedores suelen responder en 2 días