JDOC

Cómo contribuir a la documentación de Joomla!

From Joomla! Documentation

This page is a translated version of the page JDOC:How to Contribute to Joomla! Documentation and the translation is 32% complete.
Outdated translations are marked like this.

La documentación de Joomla! corre sobre el el mismo software que usa Wikipedia. Su crecimiento y éxito depende de personas como usted. Gracias por dar el primer paso para contribuir al Proyecto Joomla. Esta página le mostrará como empezar y varias formas de ayudar al esfuerzo de documentación.

New Documentation

We are currently developing new documentation based on Joomla! to demonstrate the power of our CMS.
Please don't add your contributions to this wiki anymore; the information on this page is obsolete.
Your help with the update is very welcome and appreciated! Please report your suggestions, improvements or offer for assistence on Mattermost.

Introducción

There are a few things you will need to do first.

Hay un par de cosas que tendrás que hacer en primer lugar.

Leer la política de la Wiki

Es necesario revisar la Política de la Wiki de la Documentación de Joomla! antes de empezar a editar.

Crear una cuenta de usuario

Para editar la Wiki de la documentación de Joomla!, necesitarás una cuenta de usuario. Puedes registrarte aquí. Después, asegúrate de confirmar tu dirección de correo electrónico, la confirmación de tu dirección de correo electrónico te dará permiso para editar cualquier página, excepto unas pocas que están protegidas.

You need to review the Joomla! Docs Wiki policy before you start editing.

Create a User Account

To edit the Joomla! Documentation Wiki, you will need a user account. You may register for one here. Afterwards make sure to confirm your email address. Confirmation of your e-mail address will give you permission to edit any page except for a few that are protected.

Nota: Si no haces ninguna edición en los 5 días tras la creación de tu cuenta, tu cuentá se borrará automáticamente por motivos de seguridad.

Crear una página de usuario

Después de haber creado una cuenta, haber confirmado tu dirección de correo electrónico y haber iniciado sesión, debes crear una página de usuario. Una forma rápida para iniciar este proceso es:

After you have created an account, confirmed your email address and logged in, we recommend you take a few moments to create a User page. Creating a user page serves a few purposes:

  • It lets users find out more about you.
  • It lets you make some initial edits so that the Wiki spammer and abuse filter can see that you're not a fake user. Note that for your first few edits, don't include external links as that will be what is most likely to trigger the filters.

A quick cheat to start your user page:

  • On the user menu, go to your Username page (or use first menu item on far right dropdown)
  • Click the actions drop down button
  • Haz clic en crear
  • Añade el código al editor {{subst:Newuser}}
  • Rellena el resumen (p. ej. "Esta es mi nueva página de usuario")
  • Haz clic en el botón guardar

Únete a la Lista de Correo de Documentación

Debes unirse a la Lista de correo de Documentación. No es rrequerido pero hay discusiones que te puedes perder y que son relevantes para la documentación.

Joomla's official communication tool is Mattermost. See this page for information on how to join the conversation and once you're in there, join the PD Documentation channel to join the discussion on Joomla! Documentation.

¿Qué debo hacer primero?

Hay varias áreas de documentación, que siempre necesitan atención. Puedes comenzar mediante la selección de lo que sea más cómodo para ti o puedes involucrarte más, trabajando en varios a la vez. Una vez que tienes una cuenta en la wiki, eres libre de trabajar sobre cualquier aspecto de la documentación que te apetezca ¡Incluso la más simple de las contribuciones, tal como correcciones de ortografía y revisiones gramaticales son una gran ayuda!

Ayuda a gestionar nuestro contenido

  1. Edición, reescritura y reorganización de las páginas. Consulta nuestras Páginas necesarias para las áreas que necesitan ayuda inmediata. Son las denominadas "Páginas Necesarias" porque requieren pequeñas tareas para completarse. Algunas de ellos son tan simples como revisar el contenido o la adición de una imagen. Otras requieren más contenido o mejoras. Recoge algunas, dales un poco de amor. Esta es una tremenda ayuda para los usuarios de Joomla! que confían en nuestra documentación.
  1. Puedes divertirte buscando los artículos que son redundantes, de versión anteriores (es decir, 1.0 y 1.5), o que deben ser divididos por tener una información específica de la versión. A continuación, siéntete libre de hacer uso de las plantillas {{delete}}, {{merge}} o {{JSplit}} en los artículos. Has clic en el enlace plantilla anterior para ver cómo utilizar y aplicarlas a los artículos que crees necesitan estos marcadores. Añádelo a la parte superior de una página y la página quedará marcada.
  1. Crear una nueva página o tutorial. Si quieres empezar una nueva página, haz una investigación extensa en primer lugar. Trata de no crear un nuevo artículo si ya existe uno relacionado. Usa la función de búsqueda de la documentación de la Wiki para ver si el tema ya está en un artículo. Los duplicados se fusionan y/o eliminan. No tengas miedo de modificar, reformar o mejorar el trabajo de alguien más en la Wiki de la documentación de Joomla!. Esta es una documentación wiki colaborativa, sólo asegúrate que estás siguiendo nuestras políticas y directrices.
    1. "Usando wikienlaces." Es muy fácil crear enlaces hacia páginas usando una sintaxis estándar. Si creas un enlace a un artículo que no existe aún, el enlace tendrá el color rojo. Hacer clic en un enlace rojo te llevará a la página de edición para el nuevo artículo; empieza a escribir tu texto, haz clic en guardar y la nueva página será creada. Una vez la página haya sido creada, el color del enlace cambiará de rojo a azul, indicando que el artículo ahora existe.
    2. "Usando la URL." Úsalo cuando quieras crear una página desde cero. Puedes usar la URL de la wiki para crear una página: la URL de un artículo de la wiki es generalmente algo así: https://docs.joomla.org/TITULO. Si reemplazas TITULO con el nombre de la página que deseas crear, aterrizarás en una página en blanco que indicará que no hay un artículo con ese nombre aún. Si haces clic en "Crear esta página", te permitirá crear dicha página, ingresando tu texto y haciendo clic en "Guardar".
    1. Using Wikilinks. It's very easy to link pages using a standard syntax. If you create a link to an article that doesn't exist yet, the link will be colored red. Clicking a red link will take you to the edit page for the new article. Simply type your text, click save and the new page will be created. Once the page has been created, the link will change from red to blue indicating that the article now exists.
    2. Using the URL. To use when you want to create a page from scratch. You can use the Wiki's URL for creating a new page. The URL to an article of the Wiki is usually something like this: https://docs.joomla.org/YOURTITLE. If you replace YOURTITLE with the name of the page you wish to create, you will be taken to a blank page which indicates that no article of that name exists yet. Clicking the Create this page link will take you to the edit page for that article, where you can create the new page by typing your text, and clicking Submit.
  1. Ayuda con la actualización de las imágenes en los artículos. Comprueba la categoría Necesita actualización de imagen para obtener una lista de páginas que necesitan sus imágenes actualizadas. Nuestra directrices de sugerencias para ayudar a encontrar en el artículo, directrices para los nombres a la Imagen.

Mantenimiento de la Wiki

Mantener una wiki y mantenerla organizada tiene un montón de trabajo continuo por parte de los administradores, editores y usuarios. Siempre hay tareas que requieren atención, tales como: Categorización, asistir a las páginas con necesidades, en construcción, o mediante la marcación de las páginas a eliminar, fusionar o dividir. Para todas las tareas de mantenimiento e ideas de cómo puedes ayudar, por favor visita nuestra página de Mantenimiento de la Documentación.

Proyectos de documentación

  • Los equipos de documentación están trabajando en Tutoriales para Principiantes. Nuestro objetivo es lograr que sean fáciles de entender y navegar, algo que un Principiante pueda seguir fácilmente y aprender los conceptos básicos. Piensa de nuevo cuando eras nuevo en Joomla! y añadir un tema sobre algo luchabas como un principiante con la página. Mejor aún, únete al Proyecto Tutoriales para Principiantes.

Pantallas de ayuda

¡Desconocido para muchos, todas las páginas de Pantallas de Ayuda se crean y sirve a cada instalación de Joomla! de todo el mundo a partir de esta wiki! Son necesarias para los principiantes e incluso para aquellos con un nivel intermedio de conocimientos de Joomla!

  • Las pantallas de ayuda de Joomla! 4.x deben estar completamente creadas . Cualquier contribución que brindes será apreciada por muchos usuarios de todo el mundo y estamos buscando voluntarios para ayudar con esta importante tarea. Se debe establecer una matriz así como un plan de acción.

Cosas para recordar

Aquí hay unas cuantas cosas a tener en cuenta por todo el que contribuye a la documentación de Joomla!

  • No tengas miedo de romper una página, si lo haces y es que algo ha ido muy mal, revierte tu edición. Has clic en la pestaña Historial de la página y verás enlaces para deshacer y volver a un estado anterior.
  • Escribe artículos con un sentido ya que va a ser traducido a otro idioma. El uso de jerga o dialecto local no se puede traducir a otro idioma o entender sus inferencias. Obtenga más información sobre Traducción de documentación de Joomla.
  • Palabras para ver a la hora de escribir, leer la guía completa … o utilizar retroalimentación instantánea de los navegadores Google Chrome o Mozilla Firefox. Ambos tienen un corrector ortográfico en el que se subraya una palabra mal escrita.
  • No te olvides de añadir la plantilla {{inuse}} a un artículo en el que se va a estar trabajando durante un largo período de tiempo, más de un minuto. Ayuda a prevenir conflictos de edición.

¡Ayuda, no conozco el formato Wiki!

Si eres nuevo en el uso de Wikis y el formato simple para crear páginas, entonces puedes usar lo siguiente como ayuda.

  • Nuevo WikiEditor contiene botones y enlaces para hacer la construcción de las páginas más fácil. Has clic en la palabra 'Avanzado' para un desplegable con más botones y enlaces al formateo rápido.
  • Usa el Intructivo de la Wiki de JDOC para aprender la sintaxis básica de los comandos. También hay un desplegable de las marcas comunes en el editor. Simplemente has clic en la palabra 'Ayuda' una vez y aparecerá.
  • ¿Todavía tienes miedo? Prueba estas herramientas para ayudarte a crear grandes páginas wiki.
  • Complemento de Microsoft Word en formato Wiki, guardar documentos de Word en formato Wiki.
  • OpenOffice.org versiones 2.4 y posteriores tiene un filtro de exportación a MediaWiki interno. Sólo tienes que abrir un documento de Writer y haga clic en Archivo - Exportar. A continuación, cambiar el formato de Archivo a MediaWiki.
  • Aquí hay una

lista de herramientas disponibles para convertir otros formatos a formato wiki, por ejemplo, HTML, Excel, CSV. Algunos de ellos son convertidores en línea, cortar y pegar el código HTML para una salida en formato wiki.

  • Obtén ayuda sobre Glip (tenemos 2 grupos para JDocs: uno el Grupo de Traducción y otro el grupo de Trabajo).
  • Publica una pregunta en la página de discusión de un un administrador o editor .