1 Contribuyendo al Cookbook
La comunidad CakePHP depende de las contribuciones de gente como tú. La documentación fue diseñada para permitirle a cualquier persona recomendar y agregar tantos cambios como sean necesarios. Antes de hacerlo, hay algunos lineamientos que debes seguir:
- Se conciso. Las personas buscan respuestas rápidas y no quieren leer largos bloques de texto para llegar a ella.
- Puedes enviar texto plano (párrafos), estos serán formateados a HTML automáticamente.
- Divide tu contenido. Particiona tu contenido para hacerlo más fácil de revisar. Utiliza sub-secciones, bloques de código, listas y tablas apropiadamente.
- Utiliza las etiquetas <code> para las líneas de código inline. No utilices comillas alrededor del código. Por ejemplo, "La variable <code>
$uses</code> especifica que modelos utilizar." - Utiliza las etiquetas <pre> para los bloques de código. Por ejemplo:
<pre> $this->functionName(); $this->otherFunctionName(); </pre>
Ya no es necesario utilizar Escape en el contenido pre
- Las rutas de archivos y las URL's deben estar contenidas en las etiquetas <kbd>.
- Utiliza example.com cuando necesites referenciar un dominio genérico. El propósito es ser genérico y nunca ser asociado con spam o sitios porno.
- Los vínculos a otros recursos en el libro deben ser sin el dominio. Ejemplo. /es/view/181/built-in-helpers
- Los códigos de ejemplo deben cumplir con los Estándares de codificación CakePHP.
- Y finalmente: Revisa el preview! Si te parece que no se ve bien - no se verá bien al ser revisado.
Ver comentarios para esta sección
