Add Description for Cloud Native Buildpack and Tools with Repo Links in README
@Ayush9026 ya está trabajando en esto.
Desde el 21/4/2024.
Evaluación
- Dificultad
- 3/5
- Tiempo estimado
- Medio día
- Aptitud para principiantes
- 48/100
- Tipo de issue
- Documentación
- Claridad
- Bastante claro
- Estado de actividad
- Estancado
- Stack tecnológico
- html, markdown
- Área
- documentation
Línea de trabajo
Open the repository README and add a Cloud Native Buildpack Description section plus subsections for each associated tool with a short purpose and a hyperlink to that tool's repo. Confirm which tools belong in the ecosystem from existing docs or linked CNB projects, then keep the new copy concise. Done when the README lists the buildpack and tools with working repo links.
Escrito por el modelo de indexación a partir del texto del issue.
Descripción
Summary
We need to enhance the README file for our Cloud Native Buildpack repository by adding detailed descriptions for the buildpack and all associated tools. This will provide users with a clear understanding of what each tool does and how it contributes to the Cloud Native Buildpack ecosystem.
What questions should this documentation answer?
- The enhanced README will serve as a comprehensive guide for users, showcasing the Cloud Native Buildpack ecosystem and facilitating better understanding and utilization of the tools.
Who is the target audience for this documentation?
- App Developer
- Buildpack Author
- Operator
- Other:
Additional Information
-
Add a section in the README titled "Cloud Native Buildpack Description" with a brief overview of CNBs.
-
Include subsections for each tool, such as "Tool A Description," "Tool B Description," and so on.
-
Write concise descriptions for each tool, highlighting its purpose, functionalities, and contributions to the buildpack workflow.
-
Provide hyperlinks to the respective repositories of each tool for easy access and further exploration.
- Lenguaje dominante
- HTML
- Estrellas
- 36
- Forks
- 244
- Merge medio
- 4 d 1 h
- PR fusionados (30 d)
- 6
Preparar el entorno
- 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 buildpacks/docs
-
Community calendar event popup has a broken close button and doesn't match the site designPosiblemente ocupada @Pranav-IIITM la tomó hace 13 días. Abierto
Dificultad 2/5 1-3 horas Aptitud para principiantes 62/100
buildpacks/docs#990 ·
-
AlphaAbierto
Dificultad 5/5 Más de una semana Aptitud para principiantes 15/100
buildpacks/docs#996 ·
-
Dificultad 3/5 1-2 días Aptitud para principiantes 62/100
buildpacks/docs#986 ·
-
UI/UX Improvements for Features Comparison TablePosiblemente ocupada @Pranav-IIITM la tomó hace 42 días. Abierto
Dificultad 2/5 1-3 horas Aptitud para principiantes 35/100
buildpacks/docs#974 ·
-
Dificultad 3/5 1-2 días Aptitud para principiantes 48/100
buildpacks/docs#902 ·
Todos los issues de buildpacks/docs
Issues similares
-
Dificultad 2/5 1-3 horas Aptitud para principiantes 72/100
-
bug
Dificultad 1/5 1-3 horas Aptitud para principiantes 83/100
obsidianmd/obsidian-help#1164 ·
Los mantenedores suelen responder en 1 día
-
Dificultad 1/5 Menos de una hora Aptitud para principiantes 88/100
Los mantenedores suelen responder en 1 día
-
Dificultad 1/5 Menos de una hora Aptitud para principiantes 85/100
-
OAuth documentation for GET /api/v2/users/me/ appears inconsistent with required global read scopeAbierto
Dificultad 2/5 1-3 horas Aptitud para principiantes 68/100
Los mantenedores suelen responder en 1 día