Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Completar la documentación #43

Open
danielgj opened this issue Oct 5, 2019 · 9 comments
Open

Completar la documentación #43

danielgj opened this issue Oct 5, 2019 · 9 comments
Labels
begginer-friendly documentation good first issue Good for newcomers hacktoberfest Support Open Source while having fun!

Comments

@danielgj
Copy link
Contributor

danielgj commented Oct 5, 2019

Ordenar y explicar mejor el proceso de desarrollo, setup y ejeución.

@danielgj danielgj added good first issue Good for newcomers begginer-friendly hacktoberfest Support Open Source while having fun! documentation labels Oct 5, 2019
@cagomezr
Copy link
Contributor

cagomezr commented Oct 6, 2019

Quisiera tomar este bug, tambien quisiera pedir clarificaciones en que necesitas detallado mas explicitamente

@danielgj
Copy link
Contributor Author

danielgj commented Oct 6, 2019

Hola! Básicamente es ordenar y completar el fichero README. Echo en falta un poco de contexto de para que sirve el API, como se puede acceder a ella en su version desplegada, como acceder a la documentación y ya por útlimo como se tiene que instalar el software necesario en local para hacerlo correr. Es todo un poco abstracto si conoces el proyecto. Quizaá debería darte una charlas rápida sobre esto, ¿cómo lo ves?

@cagomezr
Copy link
Contributor

cagomezr commented Oct 6, 2019

Te mande un pull para tratar de ordenar la organizacion para hacerla un poco mas clara asumo quieres que ensene como usar el API

las cosas que faltan segun lo que entiendo es instucciones mas claras:
instalar las 2 piecas de software necesitaras para hacerlo correr localmente.
como acceder la documentacion una vez api esta corriendo,
me falta algo mas?

@danielgj
Copy link
Contributor Author

danielgj commented Oct 7, 2019

Hola @cagomezr
La PR está guay, si te ha llegado un mensaje sobre hacerla en dev olvídalo.
En breve te acepto la PR.

@cagomezr
Copy link
Contributor

cagomezr commented Oct 7, 2019

gracias! si necesitas mas ayuda por favor hasmelo saber me gusta hacer documentacion.

@danielgj
Copy link
Contributor Author

danielgj commented Oct 11, 2019

Hay un error en el readme que apunta a una url incorrecta de donde está desplegado Eventpoints en netlify.
Donde pone osw.eventpoints.netlify.com hay que poner osw-eventpoints.netlify.com
Asi mismo, el contador de cuándo fue el último commit también tiene un error.
Habría que revisar en general que todos los enlaces apuntan a donde deben.

@danielgj
Copy link
Contributor Author

Hola @cagomezr
Si te animas a revisar esto de nuevo, he subido una nueva versión del README aumentada. He visto que hay algunos enlaces que no están bien por si quieres echarle un ojo ;)

@cagomezr
Copy link
Contributor

Si con gusto lo hago mas garde salga de mis mundanas onligaciones

@JukMR
Copy link
Contributor

JukMR commented Oct 11, 2019

Hola! Me gustaría subir la versión del Readme que corregí al traducir la version en ingles. Arregla un par de errores pequeños y agrego el mismo enlace para cambiar de idioma, que puse en la nueva traducción.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
begginer-friendly documentation good first issue Good for newcomers hacktoberfest Support Open Source while having fun!
Projects
None yet
Development

No branches or pull requests

3 participants