Como hacer contribuciones casuales

Fedora Documentation Team Last review: 2023-26-06
Para realizar los cambios en la página Docs hospedada en GitLab, tiene un editor web incrustado que hace su primera contribución más fáciles que nunca. Comienza editando documentación en GitLab Web IDE que puede lanzar en una pulsación. No necesita permisos especiales o acceso de escritura para el proyecto original.

  • No hay ninguna necesitad de instalar apps o clonar repos en su equipo local, o ejecutar instrucciones de Git en la terminal.

  • No hay ningún riesgo de romper algo.

  • Esta guía es para el repo hospedado por GitLab.

Como editar documento con el IDE web

Paso 1. Seleccione una página a editar

  • Vaya a la página Docs que desea editar.

  • Navegue a la cima derecha y ubique tres botones.

  • Pulse el botón del medio en editar la página para hacer correcciones.

El botón izquierdo avanza al historial de versión de la página de Docs abierta como una referencia. El botón izquierdo informar un problema está cuando puede informar cualquier cambio o actualización requerida.
1CUT changeIdentified
1A changeIdentified

  • Log in to your existing GitLab account

  • Utilice el enlace SAML para enlazar su cuenta a FAS

  • Será redirigido y pedida sus credenciales FAS si son necesarias

  • Permisos otorgados a Fedora

Crea una cuenta si no desde una aún (consulte la imagen a continuación).

2 GitLabSignin
Esta guía del contribuidor camina a lo largo del IDE Web, introducido en la publicación GitLab 15.7. La guía además refleja un cambio reciente sobre how to update fork.

Paso 2. Cree su proyecto (copiar)

Pulse el botón Abrir en IDE Web. ALternativamente, presione . (punto) en el teclado para lanzar el IDE Web.

3 EditPage

Bifurcar un proyecto la primera vez

Pulse sobre el botón Bifurcar.

The Fork button appears only the first time you contribute to the repository of a given Docs page. If you are contributing to the Fedora project for the first time and you do not have write access for the repository you want to contribute to, you need to fork a project.

A fork is a personal copy of the repository, which you create in your namespace.

4 EditFork

Si ha bifurcado un proyecto antes

If you have a forked project before, you will be forwarded automatically to the next step without the Fork button.

If you do not launch Web IDE from your fork, edit fork in Web IDE button will appear in lieu of the Open in Web IDE button. Then you will be prompted to go to fork and checkout to your fork.

  • Go to your forked project.

  • Check the status of your fork underneath Web IDE button.

If your fork shows Up to date with the upstream repository, go to step 3 in Web IDE.

update fork no
Figura 1. Bifurcación está actualizada

If your fork is behind upstream, you will see UI text how far your fork is behind.

update fork yes
Figura 2. Actualizar rama

  • Pulse el botón Actualizar rama.

  • The fork will display Up to date with the upstream repository

  • Update fork button disappears after fork is updated

Step 3. Create a new branch (version)

On your forked project, create a new branch and switch to it following the steps below.

  • On the status bar underneath in the lower-left corner, click the current branch name (normally main).

  • From the dropdown list, select Create new branch….

  • Type the branch name that is specific to a task.

  • Pulse Intro.

  • Checkout to a new branch. Click Yes to the following pop-up box.

Are you sure you want to checkout <branch-name>? Any unsaved changes will be lost.

Paso 4. Edite y guarde los cambios

Ahora, para hacer los cambios necesarios en el IDE Web. Para escribir con consistencia, refiera a La guía de estilo de docs

editor
Figura 3. Editor de IU

Once you’ve finished, select the source control button and click the file underneath changes below Commit & Push button) to view your changes.

Type a commit message and click Commit & Push. Click No to commit to existing branch.

Step 5. Create Merge Request (MR)

In the lower-right corner, you will find three options - create MR, Go to project, Continue working.

commit
Figura 4. Create MR button

  • Pulse Crear MR para crear solicitud de unión.

  • Edite el título y la descripción de la página.

  • Arrastre al botón azul Crear solicitud de unión y púlselo.

Go to project option is suitable when you made small commits by stage and want to squash them into one. Continue working is when you want to make smaller commits by sub tasks. If you select Create MR, the UI will navigate to merge request.
create mr
Figura 5. Solicitar Unión

If merge request is successful, you will see the following result in the lower-middle of merge request.

Ready to merge by members who can write to the target branch.

Paso 6. Revisar

Your request will be reviewed by Docs team. You will expect one of the following actions.

  • Reviewers ask you to revise your changes

  • Aprobar

  • Rechazar y cerrar MR con motivo

Whatever the case it is, MR comments facilitate collaboration between contributors and reviewers. Everyone can learn from those comments and corrections.

Once your MR is approved, the process is complete.

¡Gracias por su contribución!

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