Skip to content

Commit 2ffc154

Browse files
ricardochlSplaktar
authored andcommitted
feat: add guides to update-origin and contributing
- README.md - UPDATE-ORIGIN.md - CONTRIBUTING.md Auto stash before rebase of "refs/heads/main"
1 parent 492b4dc commit 2ffc154

File tree

3 files changed

+153
-0
lines changed

3 files changed

+153
-0
lines changed

CONTRIBUTING.md

Lines changed: 87 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,87 @@
1+
# Contribución al proyecto angular-docs-es
2+
3+
## Configuración de origin
4+
5+
- `origin`: Manejo del repositorio `angular/angular`como un submódulo.
6+
- `adev-es`: Se administra el contenido de la documentación de Angular, aquí se encuentran los archivos traducidos y no traducidos en formato markdown.
7+
8+
## Configuración del directorio de adev
9+
10+
Básicamente traduce archivos de Markdown en el directorio `content`. Si es necesario, también puede agregar el código fuente de la aplicación.
11+
12+
```
13+
origin/adev/
14+
├── README.md
15+
├── content # Archivos de recursos de documentación escritos en Markdown, HTML, etc. Traduzca principalmente los archivos aquí.
16+
│ ├── best-pratices
17+
│ ├── ecosystem
18+
│ ├── guide
19+
│ ├── introduction
20+
│ ├── references
21+
│ ├── tools
22+
│ ├── error.md
23+
│ └── kitchen-sink.md
24+
├── app # Contenido de la aplicación de angular.dev
25+
...
26+
```
27+
28+
## Creación de un problema de traducción
29+
30+
Antes de comenzar el trabajo de traducción, vamos a comprobar si no hay nadie que está tratando de traducir el mismo archivo. Si miras la etiqueta de [docs-translation](https://github.com/angular-hispano/angular-docs-es/labels/docs-translation), puedes ver el área en la que se está trabajando actualmente en la traducción. Si desea hacer una nueva traducción, primero cree un [problema en Github](https://github.com/angular-hispano/angular-docs-es/issues) y complete la información de acuerdo con la plantilla.
31+
32+
## Crear una solicitud de extracción de traducción
33+
34+
Empuja los cambios al repositorio donde bifurcaste `angular/angular-docs-es` y envía una solicitud de extracción a la fuente de bifurcación. Las solicitudes de extracción se revisan y luego se fusionan si no hay problemas.
35+
36+
## Directrices para la traducción
37+
38+
Para traducciones al español, por favor sigue las siguientes pautas.
39+
40+
### Guarda el texto original como un archivo.en.md
41+
42+
Para gestionar el `diff` del texto original después de actualizar el origen, guarda el original en el momento de la traducción como un archivo `xx.en.md`. Si desea traducir un documento nuevo, copie el archivo `xx.md` escrito en inglés al archivo `xx.en.md` y sobrescriba el archivo `xx.md` con la traducción al español.
43+
44+
Si la traducción es parcial y no del documento completo, no necesitas duplicar/crear el archivo `xx.en.md` simplemente puedes trabajar sobre el archivo `xx.md` con la traducción al español.
45+
46+
### Alinear la posición de salto de línea con la original
47+
48+
Siempre que sea posible, alinear el número de líneas en la fuente y la traducción, y ayudar a hacer la comprobación de diferencias más fácil al actualizar.
49+
50+
### Recomendaciones
51+
52+
- Bifurca este repositorio en tu espacio de trabajo de Github para poder colaborar de una manera más limpia y ordenada.
53+
54+
- Se recomienda encarecidamente firmar todos los commits que envíes al repositorio. Esto ayudará a mantener la integridad y la seguridad del código base, y a fomentar un entorno de colaboración más confiable entre los desarrolladores.
55+
56+
## Configura tu entorno local
57+
58+
### 1. Clonación del repositorio
59+
60+
```
61+
$ git clone [email protected]:angular-hispano/angular-docs-es.git
62+
```
63+
64+
### 2. Servidor de desarrollo
65+
66+
Al iniciar el servidor local de desarrollo, puede traducir mientras comprueba el resultado de la compilación.
67+
68+
```
69+
$ yarn start
70+
```
71+
72+
El navegador se iniciará automáticamente cuando el servidor local esté listo `adev-es` será reconstruido automáticamente al cambiar un archivo en el directorio.
73+
74+
75+
### 3. Construye para producción
76+
77+
Construye el proyecto desplegable con el siguiente comando.
78+
79+
```
80+
$ yarn build
81+
```
82+
83+
Cuando se completa la compilación, el resultado de la compilación se envía al directorio `build/dist/bin/adev/build`. Puedes configurar un servidor de desarrollo con tu herramienta favorita y comprobar los sitios construidos.
84+
85+
## Gracias por tu colaboración!
86+
87+
Esperamos que te unas a nosotros en este esfuerzo por hacer que la documentación de Angular sea más accesible para la comunidad hispanohablante.

README.md

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
# Documentación de Angular en Español
2+
3+
¡Bienvenido al repositorio de traducción al español de la documentación de Angular!
4+
5+
Este proyecto tiene como objetivo crear una versión completa en español de la documentación oficial de Angular. La documentación está escrita en Markdown, lo que facilita la traducción y colaboración.
6+
7+
Puedes conocer más sobre este proyecto en [Angular Hispano](https://angular.lat/)
8+
9+
## Contrubuciones
10+
11+
Si deseas colaborar con este proyecto, puedes contribuir a la traducción de documentos, revisa la guía de contribución en [CONTRIBUTING.md](./CONTRIBUTING.md).
12+
13+
14+
## Actualizar el origen
15+
16+
Revisa la guia de actualización en [UPDATE-ORIGIN.md](./UPDATE-ORIGIN.md)
17+
18+
19+
## Comunidad
20+
21+
Puedes unirte a nuestra comunidad en [Angular Hispano Discord](https://discord.gg/zRsMufaS)

UPDATE-ORIGIN.md

Lines changed: 45 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,45 @@
1+
# Actualizar el origen al contenido actual de angular.dev
2+
3+
## Flujo de trabajo
4+
5+
Para actualizar el origen que se encuentra en la carpeta `origin` simplemente debes ejecutar el comando `npm run update-origin` y debes pasar como primer argumento el id del commit que deseas actualizar.
6+
7+
Ejemplo: `npm run update-origin 123456789`
8+
9+
Este script se encargara se actualizar de actualizar la carpeta `origin` con el contenido del commit que se le pasa como argumento y adicional actualizara la carpeta `adev-es` si es necesario ya que esa carpeta contiente las guías de la documentación de Angular.
10+
11+
## Migración
12+
13+
### Patrón 1 - Archivos sin traducción
14+
15+
- `form-validation.md` (no traducido)
16+
- `reactive-form.md`
17+
- `structural-directives.md`
18+
19+
Si no hay ningún archivo traducido, se aplicará tal cual.
20+
21+
### Patrón 2 - Archivo con traducción
22+
23+
##### Si el cambio es pequeño
24+
25+
- `form-validation.en.md` (si tiene la extención `en.md` significa que ya está traducido, parcial o totalmente)
26+
- `reactive-form.en.md`
27+
- `structural-directives.en.md`
28+
29+
##### Si el cambio es pequeño
30+
31+
Si algún cambio requiere una nueva traducción, se reflejará en el archivo `xx.en.md`. Puedes agregar la traducción al archivo `xx.md`.
32+
33+
##### Si el cambio es grande
34+
35+
1. Copie el texto original en la parte correspondiente del archivo traducido, dejándolo sin traducir, para que tenga un estado mixto en inglés y español.
36+
37+
2. Cree un problema en Github solicitando traducciones para las partes no traducidas.
38+
39+
### Patrón 3 - Código de aplicación adev
40+
41+
Algunos archivos se han modificado para modificar la aplicación angular.dev.
42+
43+
- `sub-navigation-data.ts`
44+
45+
Si bien no es un archivo de contenido (markdown), manejaremos este archivo de la misma manera que un Markdown ya que debe ser traducido al español.

0 commit comments

Comments
 (0)