Un mundo tan atrapante, requiere que pienses diferente! Este, es un repositorio que pretende ser la guía para recordar, aprender o retroalimentar información sobre Mi viaje en Data Science estando presente en el tiempo y espacio.
Comenzamos aprendiendo un poco sobre la sintaxis usada en markdown, un lenguaje de marcado sencillo, que sirve para agregar formato, vínculos e imágenes con facilidad a un texto simple.
- A largo plazo, que cualquiera pueda aprender de el armado y mantem de repositorios, archivos readme, markdown, etc.
- A medio plazo, tener información de calidad para poder retroalimentar o recordar partes de código, definiciones y demás sobre IT.
En el repositorio, se irán creando carpetas, por las distintas áreas, campos o temas de interes, ejemplo: Jupyter, HTML, etc... Cada carpeta contiene un archivo README.md y una carpeta llamada Images. En el archivo README.md se documentará todo lo que más se pueda acerca de dicha categoría y en la carpeta Images se guardará las imágenes que se insertarán en el archivo README para explicar algo gráficamente.
El archivo README.md tiene la siguiente arquitectura de la información, la cual se deberá tener en cuenta a la hora de colaborar ya sea mejorandolo, corrigiendo o creando uno nuevo para otra categoría aún no publicada:
-
Una introducción sobre la definición de la categoría, ejemplo: Java es un lenguaje de programación, etc...
-
Contribución: Recordando a las personas como pueden contribuir con el proyecto.
-
Licencia: Recordando que todo artículo publicado es bajo licencia Atribución – No comercial – Compartir igual.
-
Tabla de contenido [Con anclaje a cada item].
-
Tema 1: No olvidar poner referencias externas al final del item, para mostrar de donde se sacó la información o simplemente para ampliar dicha información. . . .
-
Tema N.
-
FAQs
-
Créditos: Si eres aportante, deja un enlace de reconocimiento, ejemplo: tu usuario de alguna red social, pagina web, etc...
-
Utiliza las opciones de GitHub como Pull Request o un Fork para colaborar con el proyecto:
Fork: Hace un clon de este repositorio en tu cuenta de GitHub. En el podrás hacer modificaciones o simplemente para tener una copia (con opción de clonarlo a tu PC también). De esa forma garantizas la información para tu uso personal.
Pull Request: Envía la sugerencias de cambio para este repositorio, los cuales hicistes en tu clon. Si son aceptadas por el master, se fucionan los cambios y el repositorio del proyecto queda actualizado.
Los archivos README.md tienen formato de lenguaje de marcado markdown que es mucho más sencillo que el lenguaje HTML. Veamos algunos ejemplo:
# Esto es un H1
## Esto es un H2
### Esto es un H3
#### Esto es un H4
*Esto es cursiva*
**Esto es negrilla**
- Esto es viñeta 1.
- Viñeta 1.1 con sangria.
- Viñeta N.
[texto a mostrar](url completa)
Usar los títulos con la almohadilla # y para anclar el título a una tabla de contenido, ponemos lo siguiente:
[texto a mostrar](#mi-titulo-a-anclar)
Encerrar la linea de código entre la tilde al revez ` Código en ASCII: alt96
Ejemplo:
`tu linea de codigo`Encerrar el bloque de código entre tres tildes al revés ``` Código en ASCII: alt96
Ejemplo:
``` //bloque de codigo... ```
Encerramos el bloque de código con las tres tildes al revés ``` y le ponemos al lado el lenguaje que se está usando, ejemplo:
```java //bloque de codigo... ```
| TITULO1| TITULO2|
| ----- | ---- |
| CONTENIDO COLUMNA 1 | CONTENIDO COLUMNA 2 |
Para mayor información sobre la sintaxis del markdown:
http://www.genbeta.com/guia-de-inicio/que-es-markdown-para-que-sirve-y-como-usarlo
https://help.github.com/articles/markdown-basics
https://guides.github.com/features/mastering-markdown/
Garantizamos tener la información de nuestro conocimiento accesible todo el tiempo, con el objetivo de recordar partes de datos claves que necesitemos en futuros proyectos o simplemente retroalimentarnos de manera colectiva gracias a la facilidad de poder contribuir entre varias personas con el proyecto.