Render API docs in PR previews
Los mantenedores suelen responder en 1 día
Nadie ha tomado este issue todavía.
Evaluación
- Dificultad
- 4/5
- Tiempo estimado
- 3-5 días
- Aptitud para principiantes
- 45/100
- Tipo de issue
- Nueva funcionalidad
- Claridad
- Bastante claro
- Estado de actividad
- Estancado
- Stack tecnológico
- html, yaml
- Área
- ci-cd, documentation
Línea de trabajo
Empieza por .github/workflows/deploy.yaml para entender cómo se construye el sitio al hacer merge; después, revisa PR #659 y la sección local-macos-development de CONTRIBUTING.md. Compara ese proceso con la vista previa de la PR enlazada en el issue. Se considera terminado cuando la documentación de API se renderiza en las vistas previas de las PR, o cuando los contributors y reviewers tienen una forma documentada más sencilla de previsualizarla.
Escrito por el modelo de indexación a partir del texto del issue.
Descripción
Description
PR previews like this:
https://github.com/rapidsai/docs/pull/679#issuecomment-3292022542
Don't currently add in all the API docs. That makes it difficult to test changes to https://docs.rapids.ai/api/
The API docs should be rendered in PR previews, or the process to test them should be made easier in some other way.
Benefits of this work
- improves release confidence in changes related to the API docs
- reduces the total maintenance and reviewer effort needed to make changes to the API docs
Acceptance Criteria
- API docs are rendered in PR previews, or some other method exists that makes it easier for contributors and reviewers to preview those docs
Approach
See the following:
- how the site is built on merge: https://github.com/rapidsai/docs/blob/main/.github/workflows/deploy.yaml
- PR that added docs on how to do this locally: #659
- those docs: https://github.com/rapidsai/docs/blob/main/CONTRIBUTING.md#local-macos-development
Notes
N/A
- Lenguaje dominante
- HTML
- Estrellas
- 52
- Forks
- 74
- Merge medio
- 2 d 14 h
- PR fusionados (30 d)
- 10
Preparar el entorno
Inicia el contenedor de desarrollo del proyecto en tu navegador, con tu propia cuenta de GitHub.
- Sin Dockerfile ni archivo de Docker Compose
- Sin plantilla de pull request
- Leer la 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 rapidsai/docs
-
Dificultad 2/5 1-3 horas Aptitud para principiantes 68/100
Los mantenedores suelen responder en 1 día
-
Dificultad 2/5 1-3 horas Aptitud para principiantes 62/100
rapidsai/docs#818 · 1 comentario ·
Los mantenedores suelen responder en 1 día
-
? - Needs Triage doc
Dificultad 2/5 1-3 horas Aptitud para principiantes 75/100
rapidsai/docs#673 · 1 comentario ·
Los mantenedores suelen responder en 1 día
-
feature request
Dificultad 4/5 3-5 días Aptitud para principiantes 45/100
rapidsai/docs#751 · 1 reacción ·
Los mantenedores suelen responder en 1 día
-
? - Needs Triage feature request
Dificultad 4/5 3-5 días Aptitud para principiantes 35/100
Los mantenedores suelen responder en 1 día
Todos los issues de rapidsai/docs
Issues similares
-
chore
Dificultad 2/5 1-3 horas Aptitud para principiantes 76/100
SignalK/n2k-signalk#368 ·
Los mantenedores suelen responder en 1 día
-
Dificultad 2/5 1-3 horas Aptitud para principiantes 80/100
vicharanashala/spurti#241 ·
-
Dificultad 2/5 1-3 horas Aptitud para principiantes 67/100
taskcluster/taskcluster#9284 · 1 comentario ·
Los mantenedores suelen responder en 1 día
-
Dificultad 2/5 1-3 horas Aptitud para principiantes 82/100
ROCm/rocm-systems#13754 · 2 comentarios ·
Los mantenedores suelen responder en 2 días
-
Dificultad 2/5 1-3 horas Aptitud para principiantes 76/100
splunk/terraform-provider-splunk#256 · 1 comentario ·
Los mantenedores suelen responder en 1 día