Ideas de Google Season of Docs

Fedora sigue solicitando ser una organización mentora de GSoD. Esta página se actualizará si somos aceptados. Actualmente estamos recopilando posibles ideas para proyectos aquí. Asegúrate de leer atentamente la información general

Si te interesa participar en la Temporada de Google Docs con Fedora, no dudes en consultar esta lista de ideas. Es posible que se añadan más ideas durante el periodo de solicitud.

Ahora, por favor, lee la sección ¿Qué puedo hacer hoy? de la página principal. Aquí encontrarás las respuestas a tus preguntas y te explicamos cómo aplicar.

No dude en ponerse en contacto con los mentores o administradores de la organización que figuran en esta página si tiene alguna pregunta o aclaración.

Org de Administradores y Mentores

Las siguientes personas están disponibles para brindar ayuda general y soporte para el programa GSoD.

  • Petr Bokoč: Redactor técnico de Red Hat, centrado en Fedora y otra documentación de la comunidad.

  • Shaun McCance: Upstream Documentation focused Community Human with extensive experience in Gnome and other communities. He is general mentor for the Fedora GSoD and will be heping folks with onboarding and getting started with Technical Writing.

  • Marie Nordin: Marie Nordin es la Coordinadora de Acción e Impacto Comunitario (FCAIC) del Proyecto Fedora, cargo que asumió en otoño de 2019. Ha colaborado con Fedora durante muchos años, comenzando en 2013 con una pasantía en Outreachy para el diseño de Fedora Badges. Marie es miembro del equipo de diseño de Fedora y la principal encargada del mantenimiento del diseño de Fedora Badges. A lo largo de los años, ha creado cientos de diseños para Fedora y ha asesorado a muchos nuevos colaboradores de diseño. Este año es co-administradora de GSoD.

  • Sumantro Mukherjee: Administrator for this program with extensive experience in new contributor onboarding, development, and Linux. Admin for GCI and GSoC for Fedora Project for last couple of years and open source contributor for 6 odd years. Loves to onbaording new contributors to Open Source and mentor.

    • Correo-e: sumantro@redhat.com

    • IRC: sumantrom en freenode (#fedora-join, #fedora-qa, #fedora-summer-coding ,#fedora-docs)

  • Fernando: Fernando es ingeniero de software en Red Hat y trabaja principalmente en el proyecto nmstate, desarrollando nuevas funcionalidades y corrigiendo errores. También ha trabajado en el kernel de Linux y el proyecto Tor en su tiempo libre.

  • Antonio Cardace: Antonio Cardace, ingeniero de software en Red Hat trabajando en NetworkManager.

  • Thomas Haller: Thomas Haller es un miembro activo de la comunidad NetworkManager y trabaja para Red Hat.

  • Till Maas : Till es colaborador de Fedora desde hace mucho tiempo y miembro de Red Hat, trabajando en nmstate. Ha contribuido a diversas partes del proyecto y actualmente forma parte del Consejo de Fedora.

Proyectos

Network Manager

NetworkManager is a FLOSS project for configuring networking on a Linux host. It is a freedesktop.org and GNOME project and available and most Linux distributions.

Project Website | Project Gitlab | Project Documentation

Nmstate

Nmstate is a library with an accompanying command line tool that manages host networking settings in a declarative manner.

Project Website | Project GitHub | Project Documentation

Fedora Docs

Fedora creates an innovative, free, and open source platform for hardware, clouds, and containers that enables software developers and community members to build tailored solutions for their users

Project Website | Pagure Repo | Project Documentation

Ideas

Proyectos Mentores Tareas

Gestor de Red

  • Redactar contenido nuevo que explique ciertos aspectos del funcionamiento de NetworkManager. En particular, una descripción general de su funcionamiento y comos.

  • Reorganizar y reestructurar el contenido de nuestras Páginas y Documentación de Github

    • Es mejor vincularse a recursos útiles (por ejemplo, páginas de NetworkManager de distribuciones específicas, nuestra documentación o artículos de blogs útiles).

  • Nuestras páginas del manual se mantienen junto con el código fuente de NetworkManager.

    • Varias de estas páginas del manual están escritas en formato docbook. En principio, son correctas, pero podrían mejorarse con revisiones y mejoras.

    • Se deberían añadir nuevas páginas de manual. Por ejemplo, para describir la herramienta «nm-cloud-setup» o «NetworkManager-wait-online». Además, los scripts del despachador se describen actualmente en «man NetworkManager». Debería tener su propia página de manual, «NetworkManager-dispatcher».

  • La página del manual «nm-settings» se genera principalmente a partir de comentarios de «gtk-doc» mediante los script propios. Actualmente, disponemos de los manuales «nm-settings», «nm-settings-keyfile» y «nm-settings-ifcfg-rh», que abarcan diferentes aspectos de las propiedades configurables en un perfil de «NetworkManager». En realidad, hay cuatro aspectos (relacionados y, a menudo, similares):

    • dbus: ¿cómo se codifica la configuración en D-Bus (man nm-settings)?

    • nmcli: cómo se representa esta configuración en nmcli (parcialmente documentado en man nmcli)

    • keyfile: cómo se conserva la configuración en formato de archivo de clave (man nm-settings-keyfile)

    • Ifcfg-rh: cómo se conserva la configuración en formato ifcfg-rh (man nm-settings-ifcfg-rh)

  • Esto debería estar mejor estructurado con cuatro páginas de manual: «nm-settings-dbus», «nm-settings-nmcli», «nm-settings-keyfile» y «nm-settings-ifcfg-rh». Esto requiere cambios en las herramientas para generar manuales más adecuados. También requiere ajustar la documentación para que se ajuste mejor a los aspectos.

  • La referencia de la API de D-Bus se genera a partir de la descripción de D-Bus de introspección en XML. Esta es probablemente la parte que requiere menos trabajo, pero también debería revisarse para ver si se puede mejorar.

  • Mejorar el archivo README de NetworkManager en nuestro Git, ya que también es un buen punto de partida para los colaboradores.

Nmstate

  • La documentación de nmstate actualmente no incluye una guía de inicio. Nos gustaría que el redactor técnico creara una guía completa sobre cómo empezar a usar nmstate.

    • Crea ejemplos de uso detallado utilizando las características diferentes que admite nmstare

    • This getting started would be added to our official webpage generated from this git repository

  • Nmstate’s API documentation is currently allocated in the official webpage. The current API documentation is outdated and lacking details. We’d like the technical writer to update and complete the current API documentation This documentation is generated from this git repository

Fedora Docs

  • Actualizar y refactorizar la Guía de instalación de Fedora

    • La Guía de Instalación de Fedora actual, si bien es adecuado, se convirtió desde una herramienta de publicación diferente hace unos años y nunca se actualizó para aprovechar la nueva herramienta modular, Antora, que utiliza actualmente el Proyecto de Documentación de Fedora. Además, partes de la Guía de Instalación también se utilizan dentro del instalador gráfico para proporcionar ayuda integrada; sin embargo, actualmente el instalador se ve obligado a usar fuentes antiguas, anteriores a la conversión.

      We would like to fix all issues described above. A writer working on this project would be expected to:

    • Modularizar la guía para que funcione como un conjunto de módulos independientes y aproveche las ventajas de Antora, en lugar de la estructura jerárquica actual. Esto implica reestructurar la estructura del archivo fuente y actualizar todas las referencias internas (xrefs).

    • Colabore con el equipo de desarrollo del instalador para garantizar que la Guía de Instalación se pueda utilizar como fuente de ayuda integrada. Tanto el equipo del Proyecto de Documentación de Fedora como el del equipo de desarrollo del instalador tienen experiencia previa en este aspecto y podrán brindar ayuda.

  • Desarrollar un conjunto de documentación que muestre las características de Fedora

    • En la documentación de Fedora falta un conjunto de documentos dirigidos a quienes estén considerando migrar a Linux, y en particular a Fedora, desde otros sistemas operativos, en particular MS Windows. Nos gustaría crear documentación que muestre las características de Fedora relevantes para el uso general del usuario doméstico, como la navegación web, la creación y edición multimedia, la reproducción de vídeo, etc.

    • Se esperaría que un escritor que trabaje en la creación de un conjunto de documentos de este tipo trabaje con varias partes interesadas en el Proyecto Fedora, como el Comité Mindshare y el liderazgo del proyecto, identifique personas y sus casos de uso específicos, y luego cree documentación que cubra estos casos de uso. La documentación de Fedora se encuentra en el lenguaje de marcado ASCIIDoc. El código fuente se almacena en Git y se publica en el Antora. Se prefiere estar familiarizado con cualquiera de estas herramientas, así como con los script básicos, pero no es necesario.

Want to help? Learn how to contribute to Fedora Docs ›