Contribución de entradas

Jonathan Wiesel edited this page Mar 1, 2015 · 4 revisions

Preparación

Al igual que con las contribuciones convencionales, primero debes hacer un fork del proyecto de Github e instalar el blog en tu máquina de esta manera podrás probar lo realizado en tu propio equipo y verificar su correcto funcionamiento y visualización antes de realizar la contribución formalmente.

Agregarte como contribuidor

Si es tu primera contribución debes agregarte como contribuidor en el blog, de lo contrario puedes saltar a la siguiente sección.

Primero dirigete al archivo _data/contribuidores.yml, y agrega una nueva sección (de último) para colocar tus datos:

- name: <nombre completo>
  github: <nombre de usuario en github>
  facebook: <nombre de usuario facebook> # el que aparece en el URL de tu perfil
  twitter: <nombre de usuario de twitter>
  gplus: <nombre usuario GooglePlus> # como aparece en el URL de tu perfil, como por ejemplo +CodeheroCo
  linkedin: <nombre de usuario LinkedIn> # como aparece en el URL de tu perfil internacional 
  web: <página web>
  email: <correo electrónico>
  description: <descripción personal>
  thumb: <nombre de archivo de tu gravatar> # como aparece en el URL cuando abres en grande la imagen de tu gravatar, por ejemplo c8bda21404dda0cdcef8cfa0c34c03de.png
  namelink: <nombre de usuario en el blog> # debe ser unico entre todos los autores y contribuidores

Si no posees (o no deseas incluir) alguno de estos datos puedes eliminarlo; sin embargo tu name y namelink son obligatorios.

Luego dirigete al directorio contributors/ y crea un archivo que tenga como nombre tu_name_link.html y contenga lo siguiente:

---
layout: default
title: <tu nombre>
author_name: <tu nombre>
description: Información de las entradas escritas por <tu nombre> en el blog de Codehero.
---
{% include templates/autor-detalle.html %}

Como podrás ver, puedes copiar y pegar este snippet por lo que lo único que tienes que poner es tu nombre.

Crear una entrada

Existen 2 maneras sencillas de crear una entrada en el blog.

Usando Prose

Prose es una herramienta sencilla e intuitiva para crear entradas para sitios basados en Jekyll sin necesidad de escribir código y lidiar con el front matter.

Accede al portal del Prose, inicia sesión con tu cuenta de Github y dirigete a tu repositorio fork del blog.

Haz click en New File para crear una entrada nueva.

Se te presentará una interfaz gráfica para que escribas tu entrada sobre la cual debes cubrir los siguientes puntos:

  • Colocarle un título.
  • Escribir entrada en formato Markdown.
  • Llenar datos de metadata (botón ubicado del lado derecho).
    • Todos los campos son obligatorios a excepción del URL de Github y Raw Metadata.

Luego seleccionas la opción Save, verificas tus cambios y realizas el commit.

Lamentablemente la opción de Preview no funciona correctamente con nuestro blog, por lo que una vez finalizado el commit deberás probarlo en tu equipo antes de hacer la contribución formal.

Procura tener tu entrada ya escrita antes de llegar a Prose, esto con la finalidad de no crear múltiples commits relacionados al mismo contenido en el repositorio.

Manual

Para crear manualmente tu entrada primero debes crear un archivo en la carpeta _posts/comunidad/ que tenga el siguiente formato:

yyyy-mm-dd-titulo-de-entrada.md

Siendo yyyy-mm-dd la fecha de escritura de la entrada. El nombre del archivo no puede poseer espacios. La extensión .md indica que es un archivo Markdown.

Suponiendo que quisieramos crear una entrada para el 01 de Marzo de 2015 que se titule "Cómo crear una entrada", el archivo sería:

2015-03-01-como-crear-una-entrada.md

Posteriormente tu archivo debe tener en la parte superior lo que llamamos el front matter o metadata de la entrada escrita en yml, debe ser algo así:

---
layout: post
status: publish
title: <titulo de la entrada>
author: <nombre del autor>
author_login: <nombre de usuario del autor en el blog>  # tal como en el namelink del usuario al agregarse como contribuidor 
description: <descripción de hasta 155 caracteres de la entrada>
dificultad: <elegir entre Novato, Aprendiz, Intermedio, Avanzado o Heroe>
duracion: <numero de minutos que se tardaría un usuario en leer la entrada>
thumbnail: <URL de la imagen de la entrada>  # procura que sea de tamaño 200x200.
categories:
- comunidad  # esta categoría es obligatoria
tags:
- <etiqueta 1>
- <etiqueta 2>
---

Luego de esto escribes todo el texto de tu entrada en formato Markdown.

Probar tu trabajo

Si estas usando Prose, debes hacer git pull de los cambios de tu fork a tu computador.

Para probar que tu trabajo funcione y se vea como esperas, navega en la línea de comandos al directorio donde tienes el proyecto y ejecuta el comando:

$ rake server

En poco tiempo el servidor estará levantado de manera local para que puedas apreciar tu trabajo desde tu explorador.

Formalizar la contribución

Luego de que hayas culminado y probado exitosamente tu contribución, sube el/los commit(s) a tu fork de Github y realiza el Pull Request al proyecto original. (más info aquí)

Reglas de redacción de entradas

  • Las entradas deben agregar valor de interes y no estar repetido en el blog (si tienes dudas sobre esto puedes abrir un issue y preguntarlo de antemano).
  • Deben estar escritas en lenguaje Markdown. (para más información puedes chequear la entrada de Markdown en el blog) o guiarte por otras entradas ya creadas en el blog.
  • El blog no almacena ninguna imagen del contenido de las entradas, estas deben ser almacenadas en proveedores externos (imgur es muy bueno) y referenciadas en la entrada con la sintaxis de Markdown necesaria.
  • Tu trabajo será revisado por algún autor principal del blog y este tendrá la potestad de solicitar los cambios que considere pertinentes o incluso rechazar la contribución si así este lo considera.
  • Al hacer una contribución estas aceptando las Políticas de Privacidad y Términos y Condiciones.
  • No se permite ningún tipo de referencia política, esto es un blog de tecnología y educación.
  • Utiliza el lenguaje adecuado, nada de groserías.