Guía de contribución de Wiki

Los siguientes estándares deberían ayudar a mantener la wiki consistente, fácil de entender para los novatos y fácil de editar para los contribuyentes casuales.

Puede haber excepciones en algunos casos donde tiene sentido, pero debe haber una buena razón para ello.

1. Los artículos deben ser fáciles de leer y editar, cuanto más simple mejor. Los artículos deben formatearse solo con las funciones básicas que se encuentran en la GUI del editor, más la etiqueta de código y la construcción de la tabla cuando sea necesario.
   ¿Por qué? Un formato más avanzado le daría a este wiki un aspecto más “profesional”, pero también será más difícil de leer y editar para usuarios casuales y colaboradores. Los diseños más avanzados con pestañas y botones son más compactos, pero generalmente son más confusos que un diseño más simple con una sola lista de acciones y enlaces donde los lectores se desplazan y hacen clic. También un diseño simple no interactivo permite una fácil impresión. Por ejemplo, mire este tutorial Instalación de fábrica: instalación por primera vez en un dispositivo.
   
   
2. Evite duplicar información dentro de este wiki: la información sobre el mismo tema aparecerá en el wiki solo una vez. Si se necesita en otro lugar, lo consultamos con un enlace.
   Por ejemplo, si está escribiendo un tutorial y uno de los pasos es “configurar el almacenamiento USB”, debe vincularlo a Uso de dispositivos de almacenamiento. ¡NO escriba (ni copie y pegue) los mismos procedimientos en su nuevo tutorial!
   
   
3. Evite duplicar la documentación ascendente: considere la posibilidad de contribuir con las partes más genéricas de la documentación a la corriente ascendente, y simplemente enlace a eso en su artículo. Esta wiki existe para la documentación relacionada con OpenWrt, por ejemplo ipv4. Algunos ejemplos de wikis ascendentes: es decir, wiki de controladores WiFi de Linux, OpenVPN Wiki, etc. No todos emplean wikis, y no todos aceptan contribuciones de terceros. Si las contribuciones aguas arriba son imposibles, entonces está bien tener esa información en la wiki de OpenWrt.
   
   
4. Información de versiones: la información de los artículos debe ser válida para la versión estable actual. La información que se aplica solo a versiones anteriores o instantáneas (ya sea en desuso o características muy nuevas) debe marcarse como tal.
   
   
5. Los artículos deberían ser fáciles de encontrar, la mayoría de las personas buscarán información con el motor de búsqueda de su elección, o con la propia búsqueda interna de la wiki. Utilice títulos breves y descriptivos e introducciones que contengan las palabras clave correctas que encontrará. Puede intentar buscar su artículo con su motor de búsqueda favorito (después de unos días publicó el artículo, porque los motores de búsqueda necesitan tiempo para actualizar sus índices). Si no encuentra su propio contenido, ¡otros probablemente tampoco lo harán!
   Por ejemplo, instalar.opkg.packages.in.mount.point.other.than.root es un título largo que podría reemplazarse con algo como opkg - Destinos de instalación, pero este último no se encontrará tan fácilmente como el primero cuando alguien no navega por la wiki, sino que utiliza un motor de búsqueda.
   
   
6. Los artículos deben explicar por qué existen, cuál es su objetivo. Agregue uno o dos párrafos de “introducción” donde explique cuál es la función que está configurando y qué necesidades se pueden satisfacer siguiendo las instrucciones. No necesita ser muy detallado. Por ejemplo, el primer párrafo aquí: Uso del generador de imágenes (generador de imágenes)
   
   
7. Los artículos deben contener información VERIFICABLE, la especulación debe estar claramente etiquetada como tal. Realmente, esto es muy importante en cualquier wiki. Cite fuentes para declaraciones que no son de conocimiento común, o escriba suficiente información para permitir la búsqueda fácil en Google de fuentes. Por ejemplo: problemas con USB 3.0 y WiFi
   
   
8. Todos los tutoriales que escriba deben ser probados personalmente o deben tener una advertencia que indique que la prueba no fue posible al escribirlos (y eliminar la advertencia cuando alguien lo probó con éxito).
   
   
9. Un tema por artículo. Los artículos deben centrarse en un tema único y centrado, por ejemplo, “instalar y configurar Adblock”. Los artículos generales que abarcan muchos temas diferentes, por ejemplo, “filtrado de tráfico web” (donde se habla de Adblock, servidores proxy y quizás Tor y VPN) deben dividirse.
   
   
10. Los tutoriales grandes deben dividirse. Los tutoriales grandes donde cada paso es largo deben dividirse en artículos separados, cada uno de los cuales cubre una parte de los pasos. Esto es aún más importante si el tutorial contiene pasos condicionales u opcionales (por ejemplo: “haz el paso A, luego puedes hacer el paso B o C, luego hacer D”). Por ejemplo, Instalación de fábrica: instalación por primera vez en un dispositivo o este "¡Hola, mundo!" para OpenWrt
    
    
11. Los artículos deben ser accesibles desde la wiki. Asegúrese de que su artículo tenga un enlace en una de las páginas principales de Categorías (enlaces a continuación) si se trata de algún tipo de tutorial. Es posible que algunos artículos no necesiten esto si forman parte de un tutorial de varios artículos, pero nuevamente asegúrese de que se pueda acceder a TODOS los artículos desde las páginas principales de Categorías o desde las otras páginas de su tutorial de varios artículos. También se vincularán artículos muy populares desde otros tutoriales, como se explica en Evitar duplicar información dentro de este mantra wiki anterior. Para obtener una lista práctica de páginas que enlazan con la página actual, haga clic en el icono de “cadena” que encuentra en el panel de herramientas derecho (está debajo del icono del reloj).

Para darle a Wiki una mejor estructura, empleamos namespaces y categories (y tags):

• Los espacios de nombres son más altos. En cada uno de estos espacios de nombres superiores, habrá un máximo de 3 (tres) subniveles.
  • sobre el proyecto OpenWrt en general
  • Documentación de TOH sobre dispositivos compatibles, denominada “Tabla de hardware”.
  • Documentación de paquetes sobre paquetes disponibles
  • Descarga la página de inicio para descargar el firmware de tu dispositivo
  • Documentación página principal de documentación
  • Wiki páginas acerca de la funcionalidad wiki y las reglas de contribución wiki
  • Preguntas frecuentes es el lugar para laslistas de preguntas frecuentes
• Las categorías proporcionan el primer nivel de los espacios de nombres. Distinguen diferentes tipos de documentos :
  • Inicio rápido inicio rápido tutoriales, utilizados para primera instalación y configuración, o similar.
  • La Guía del usuario contiene la mayor parte de la documentación para usuarios aquí
  • Guía para desarrolladores documentación para desarrolladores
• Las etiquetas son diferentes. Si bien la estructura es exclusiva, puede colocar un artículo solo en una subcategoría, las etiquetas son más flexibles. Se pueden colocar más de ellos simultáneamente en un artículo, y así permitir una categorización más flexible. Para reproducir esto con la estructura, podríamos escribir artículos simbólicos, que se colocan en diferentes subcategorías y se redirigen a un artículo. Pero no hagamos eso. Las etiquetas resultarán más útiles cuando desee buscar enrutadores con ciertas funciones.
  • Etiquetas Descripción general

Barra lateral Para facilitar la navegación, utilizamos una barra lateral, en dos lugares para “animarla”, mostrar más o menos enlaces dependiendo de dónde haya hecho clic. Cualquier cambio debe reflejarse en ambos archivos (si corresponde).

• Barra lateral para sección general