/
documentation.texy
69 lines (43 loc) 路 5.01 KB
/
documentation.texy
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
Contribuir a la documentaci贸n
*****************************
.[perex]
Contribuir a la documentaci贸n es una de las actividades m谩s valiosas, ya que ayuda a otros a entender el marco.
驴C贸mo escribir? .[#toc-how-to-write]
------------------------------------
La documentaci贸n est谩 destinada principalmente a personas que se inician en el tema. Por lo tanto, debe cumplir varios puntos importantes:
- Empezar con temas sencillos y generales. Pasar al final a temas m谩s avanzados.
- Intente explicar el tema con la mayor claridad posible. Por ejemplo, intente explic谩rselo primero a un colega.
- Proporcione s贸lo la informaci贸n que el usuario realmente necesita saber sobre un tema determinado.
- Aseg煤rese de que la informaci贸n es exacta. Pruebe cada c贸digo
- Sea conciso: reduzca lo que escribe a la mitad. Y luego no dude en volver a hacerlo.
- Utilice el resaltado con moderaci贸n, desde fuentes en negrita hasta marcos como `.[note]`
- Siga la [norma de codificaci贸n |Coding Standard] en el c贸digo
Aprenda tambi茅n la [sintaxis |syntax]. Para obtener una vista previa del art铆culo durante la escritura, puede utilizar el [editor de vista previa |https://editor.nette.org/].
Mutaciones ling眉铆sticas .[#toc-language-mutations]
--------------------------------------------------
El ingl茅s es el idioma principal, as铆 que tus cambios deben ser en ingl茅s. Si el ingl茅s no es tu fuerte, utiliza [DeepL Translator |https://www.deepl.com/translator] y otros revisar谩n tu texto.
La traducci贸n a otros idiomas se har谩 autom谩ticamente tras la aprobaci贸n y puesta a punto de tu edici贸n.
Ediciones triviales .[#toc-trivial-edits]
-----------------------------------------
Para contribuir a la documentaci贸n, es necesario tener una cuenta en [GitHub |https://github.com].
La forma m谩s sencilla de hacer un peque帽o cambio en la documentaci贸n es utilizar los enlaces que aparecen al final de cada p谩gina:
- *Mostrar en GitHub* abre la versi贸n fuente de la p谩gina en GitHub. A continuaci贸n, s贸lo tienes que pulsar el bot贸n `E` y podr谩s empezar a editar (debes haber iniciado sesi贸n en GitHub)
- *Abrir vista previa* abre un editor donde puedes ver inmediatamente la forma visual final
Como el editor de vista [previa |https://editor.nette.org/] no tiene la capacidad de guardar los cambios directamente en GitHub, necesitas copiar el texto fuente al portapapeles (usando el bot贸n *Copiar al portapapeles*) y luego pegarlo en el editor en GitHub.
Debajo del campo de edici贸n hay un formulario de env铆o. Aqu铆 no olvides resumir y explicar brevemente el motivo de tu edici贸n. Tras el env铆o, se crea una solicitud de extracci贸n (pull request, PR) que puede seguir edit谩ndose.
Ediciones m谩s extensas .[#toc-larger-edits]
-------------------------------------------
Es m谩s apropiado estar familiarizado con los fundamentos del trabajo con el sistema de control de versiones Git que confiar 煤nicamente en la interfaz de GitHub. Si no est谩s familiarizado con Git, puedes consultar la [gu铆a git - the simple guide |https://rogerdudler.github.io/git-guide/] y considerar el uso de uno de los muchos [clientes gr谩ficos |https://git-scm.com/downloads/guis] disponibles.
Edita la documentaci贸n de la siguiente manera:
1) en GitHub, crea un [fork |https://help.github.com/en/github/getting-started-with-github/fork-a-repo] del repositorio [nette/docs |https://github.com/nette/docs]
2) [clona |https://docs.github.com/en/repositories/creating-and-managing-repositories/cloning-a-repository] este repositorio en tu ordenador
3) a continuaci贸n, realice cambios en la [rama correspondiente |#Documentation Structure]
4) compruebe si hay espacios de m谩s en el texto utilizando la herramienta [Code-Checker |code-checker:]
5) guarde (confirme) los cambios
6) si est谩s satisfecho con los cambios, env铆alos a tu bifurcaci贸n en GitHub
7) desde all铆, env铆alos al repositorio `nette/docs` creando un [pull request|https://help.github.com/articles/creating-a-pull-request] (PR)
Es habitual recibir comentarios con sugerencias. No pierdas de vista los cambios propuestos e incorp贸ralos. A帽ade los cambios sugeridos como nuevos commits y reenv铆alos a GitHub. Nunca crees un nuevo pull request s贸lo para modificar uno ya existente.
Estructura de la documentaci贸n .[#toc-documentation-structure]
--------------------------------------------------------------
Toda la documentaci贸n se encuentra en GitHub, en el repositorio [nette/docs |https://github.com/nette/docs]. La versi贸n actual se encuentra en la rama maestra, mientras que las versiones anteriores se encuentran en ramas como `doc-3.x`, `doc-2.x`.
El contenido de cada rama se divide en carpetas principales que representan 谩reas individuales de la documentaci贸n. Por ejemplo, `application/` corresponde a https://doc.nette.org/en/application, `latte/` corresponde a https://latte.nette.org, etc. Cada una de estas carpetas contiene subcarpetas que representan mutaciones ling眉铆sticas (`cs`, `en`, ...) y, opcionalmente, una subcarpeta `files` con im谩genes que pueden insertarse en las p谩ginas de la documentaci贸n.