diff --git a/aio/README.md b/aio/README.md index b46467d2bf..88177f89a6 100644 --- a/aio/README.md +++ b/aio/README.md @@ -1,140 +1,131 @@ -# Angular documentation project (https://angular.io) +# Proyecto de documentación Angular (https://docs.angular.lat) -Everything in this folder is part of the documentation project. This includes +Todo en esta carpeta es parte del proyecto de documentación. Esto incluye: -* the web site for displaying the documentation -* the dgeni configuration for converting source files to rendered files that can be viewed in the web site. -* the tooling for setting up examples for development; and generating live-example and zip files from the examples. +* El sitio web para mostrar la documentación +* La configuración de dgeni para convertir los archivos de origen a archivos renderizados que se pueden vizualizar en el sitio web. +* Las herramientas para establecer ejemplos para el desarrollo; y generar archivos en tiempo real y archivos zip desde los ejemplos. -## Developer tasks +## Tareas de desarrollador -We use [Yarn](https://yarnpkg.com) to manage the dependencies and to run build tasks. -You should run all these tasks from the `angular/aio` folder. -Here are the most important tasks you might need to use: +Nosotros usamos [Yarn](https://yarnpkg.com) para gestionar las dependencias y crear tareas de compilación. +Debes ejecutar todas estas tareas desde la carpeta `angular/aio`. +Aquí están las tareas más importantes que podrías necesitar usar: -* `yarn` - install all the dependencies. -* `yarn setup` - install all the dependencies, boilerplate, stackblitz, zips and run dgeni on the docs. -* `yarn setup-local` - same as `setup`, but build the Angular packages from the source code and use these locally built versions (instead of the ones fetched from npm) for aio and docs examples boilerplate. +* `yarn` - instalar todas las dependencias. +* `yarn setup` - instalar todas las dependencias, boilerplate, stackblitz, zips y ejecuta dgeni en los documentos. +* `yarn setup-local` - igual que `setup`, pero crea los paquetes de Angular a partir del código y usa estas versiones construidas localmente (en lugar de las recuperadas desde npm) para aio y ejemplos de documentos boilerplate. -* `yarn build` - create a production build of the application (after installing dependencies, boilerplate, etc). -* `yarn build-local` - same as `build`, but use `setup-local` instead of `setup`. -* `yarn build-local-with-viewengine` - same as `build-local`, but in addition also turns on `ViewEngine` (pre-Ivy) mode in aio. - (Note: To turn on `ViewEngine` mode in docs examples, see `yarn boilerplate:add:viewengine` below.) +* `yarn build` - crear una compilación de producción de la aplicación (después de instalar dependencias, boilerplate, etc). +* `yarn build-local` - igual que `build`, pero usa `setup-local` en lugar de `setup`. +* `yarn build-local-with-viewengine` - igual que `build-local`, pero además también enciende el modo `ViewEngine` (pre-Ivy) en aio. + (Nota: Encender el modo `ViewEngine` en ejemplos de documentos, ver `yarn boilerplate:add:viewengine` abajo.) -* `yarn start` - run a development web server that watches the files; then builds the doc-viewer and reloads the page, as necessary. -* `yarn serve-and-sync` - run both the `docs-watch` and `start` in the same console. -* `yarn lint` - check that the doc-viewer code follows our style rules. -* `yarn test` - watch all the source files, for the doc-viewer, and run all the unit tests when any change. -* `yarn test --watch=false` - run all the unit tests once. -* `yarn e2e` - run all the e2e tests for the doc-viewer. +* `yarn start` - ejecutar un servidor web de desarrollo que observa los archivos; luego crea el doc-viewer y vuelve a cargar la página, según sea necesario. +* `yarn serve-and-sync` - ejecutar ambos, el `docs-watch` y `start` en la misma consola. +* `yarn lint` - comprobar que el código del doc-viewer sigue nuestras reglas de estilo. +* `yarn test` - observar todos los archivos de origen, para el doc-viewer, y ejecuta todas las pruebas unitarias cuando haya algún cambio. +* `yarn test --watch=false` -ejecutar todas las pruebas unitarias una sola vez. +* `yarn e2e` - ejecutar todas las pruebas de e2e para el doc-viewer. -* `yarn docs` - generate all the docs from the source files. -* `yarn docs-watch` - watch the Angular source and the docs files and run a short-circuited doc-gen for the docs that changed. -* `yarn docs-lint` - check that the doc gen code follows our style rules. -* `yarn docs-test` - run the unit tests for the doc generation code. +* `yarn docs` - generar toda la documentación desde los archivos fuente. +* `yarn docs-watch` - observar el código Angular, los archivos de documentación y ejecutar un 'doc-gen' en corto circuito para los documentos que fueron cambiados. +* `yarn docs-lint` - comprobar que el código del documento generado sigue nuestras reglas de estilo. +* `yarn docs-test` - ejecutar las pruebas unitarias para el código de generación de doc. -* `yarn boilerplate:add` - generate all the boilerplate code for the examples, so that they can be run locally. -* `yarn boilerplate:add:viewengine` - same as `boilerplate:add` but also turns on `ViewEngine` (pre-Ivy) mode. +* `yarn boilerplate:add` - generar todo el código boilerplate para los ejemplos, para que puedan ejecutarse localmente. +* `yarn boilerplate:add:viewengine` - igual que `boilerplate:add` pero también enciende el modo `ViewEngine` (pre-Ivy). -* `yarn boilerplate:remove` - remove all the boilerplate code that was added via `yarn boilerplate:add`. -* `yarn generate-stackblitz` - generate the stackblitz files that are used by the `live-example` tags in the docs. -* `yarn generate-zips` - generate the zip files from the examples. Zip available via the `live-example` tags in the docs. +* `yarn boilerplate:remove` - eliminar todo el código boilerplate que fue añadido a través`yarn boilerplate:add`. +* `yarn generate-stackblitz` - generar los archivos stackblitz que están usados por la etiqueta `live-example` en documentos. +* `yarn generate-zips` - generar los archivos zip desde los ejemplos. Zip está disponible a través de la etiqueta `live-example` en los documentos. -* `yarn example-e2e` - run all e2e tests for examples. Available options: - - `--setup`: generate boilerplate, force webdriver update & other setup, then run tests. - - `--local`: run e2e tests with the local version of Angular contained in the "dist" folder. - _Requires `--setup` in order to take effect._ - - `--viewengine`: run e2e tests in `ViewEngine` (pre-Ivy) mode. - - `--filter=foo`: limit e2e tests to those containing the word "foo". +* `yarn example-e2e` - ejecutar todas las pruebas e2e para ejemplos. Opciones disponibles: + - `--setup`: generar boilerplate, forzar la actualización del controlador web y otras configuraciones, luego ejecutar las pruebas. + - `--local`: ejecutar pruebas e2e con la versión local de Angular contenida en la carpeta "dist". + _Requiere `--setup` para que surta efecto._ + - `--viewengine`: ejecutar pruebas e2e en modo `ViewEngine` (pre-Ivy). + - `--filter=foo`: limitar pruebas e2e a las que contienen la palabra "foo". -> **Note for Windows users** +> **Nota para usuarios Windows** > -> Setting up the examples involves creating some [symbolic links](https://en.wikipedia.org/wiki/Symbolic_link) (see [here](./tools/examples/README.md#symlinked-node_modules) for details). On Windows, this requires to either have [Developer Mode enabled](https://blogs.windows.com/windowsdeveloper/2016/12/02/symlinks-windows-10) (supported on Windows 10 or newer) or run the setup commands as administrator. +> Configurar los ejemplos implica crear algunos [enlaces simbólicos](https://es.wikipedia.org/wiki/Enlace_simb%C3%B3lico) (ver [Aquí](./tools/examples/README.md#symlinked-node_modules) para más detalles). En Windows, esto requiere tener [Habilitado el Modo de desarrollador ](https://blogs.windows.com/windowsdeveloper/2016/12/02/symlinks-windows-10) (compatible con Windows 10 o más reciente) o ejecutar los comandos de configuración cómo administrador. > -> The affected commands are: +> Los comandos afectados son: > - `yarn setup` / `yarn setup-*` > - `yarn build` / `yarn build-*` > - `yarn boilerplate:add` > - `yarn example-e2e --setup` -## Using ServiceWorker locally +## Usando ServiceWorker localmente -Running `yarn start` (even when explicitly targeting production mode) does not set up the -ServiceWorker. If you want to test the ServiceWorker locally, you can use `yarn build` and then -serve the files in `dist/` with `yarn http-server dist -p 4200`. +Ejecutando `yarn start` (incluso cuando se apunta explícitamente al modo de producción) no configura el +ServiceWorker. Si quieres probar el ServiceWorker localmente, puedes usar `yarn build` y luego +ejecutar los archivos en `dist/` con `yarn http-server dist -p 4200`. -## Guide to authoring +## Guía de autoría +Existen dos tipos de contenido en la documentación: -There are two types of content in the documentation: +* **Documentación de API**: descripciones de los módulos, clases, interfaces, decoradores, etc que son parte de la plataforma Angular. +La documentacion de API está generada directamente desde el código fuente. +El código fuente está contenido en archivos TypeScript , almacenados en la carpeta `angular/packages`. +Cada elemento de la API puede tener un comentario anterior, el cual contiene etiquetas y contenido de estilos JSDoc. +El contenido está escrito en markdown. -* **API docs**: descriptions of the modules, classes, interfaces, decorators, etc that make up the Angular platform. -API docs are generated directly from the source code. -The source code is contained in TypeScript files, located in the `angular/packages` folder. -Each API item may have a preceding comment, which contains JSDoc style tags and content. -The content is written in markdown. +* **Otro contenido**: guias, tutoriales, y otro material de marketing. +Todos los demás contenidos se escriben utilizando markdown en archivos de texto, ubicados en la carpeta `angular/aio/content`. +Más específicamente, hay subcarpetas que contienen tipos particulares de contenido: guías, tutoriales y marketing. -* **Other content**: guides, tutorials, and other marketing material. -All other content is written using markdown in text files, located in the `angular/aio/content` folder. -More specifically, there are sub-folders that contain particular types of content: guides, tutorial and marketing. +* **Ejempos de código**: los ejemplos de código deben ser comprobables para garantizar su precisión. +Además, nuestros ejemplos tienen un aspecto específico y permiten al usuario copiar el código fuente. Para mayor +ejemplos se representan en una interfaz con pestañas (e.g. template, HTML, y TypeScript en pestañas separadas). Adicionalmente, algunos son ejemplos en acción, que proporcionan enlaces donde se puede editar el código, ejecutar, y/o descargar. Para obtener más detalles sobre cómo trabajar con ejemplos de código, lea los [fragmentos de código](https://docs.angular.lat/guide/docs-style-guide#code-snippets), [código fuente de marcado ](https://docs.angular.lat/guide/docs-style-guide#source-code-markup), y [ ejemplos en acción ](https://docs.angular.lat/guide/docs-style-guide#live-examples) paginas de los [ autores de guías de estilo ](https://docs.angular.lat/guide/docs-style-guide). -* **Code examples**: code examples need to be testable to ensure their accuracy. -Also, our examples have a specific look and feel and allow the user to copy the source code. For larger -examples they are rendered in a tabbed interface (e.g. template, HTML, and TypeScript on separate -tabs). Additionally, some are live examples, which provide links where the code can be edited, executed, and/or downloaded. For details on working with code examples, please read the [Code snippets](https://angular.io/guide/docs-style-guide#code-snippets), [Source code markup](https://angular.io/guide/docs-style-guide#source-code-markup), and [Live examples](https://angular.io/guide/docs-style-guide#live-examples) pages of the [Authors Style Guide](https://angular.io/guide/docs-style-guide). +Usamos la herramienta [dgeni](https://github.com/angular/dgeni) para convertir estos archivos en docs que se pueden ver en el doc-viewer. +Las [guías de estilo para Autores](https://docs.angular.lat/guide/docs-style-guide) prescriben pautas para +escribir páginas de guía, explica cómo usar la documentación de clases y componentes, y cómo marcar el código fuente para producir fragmentos de código. -We use the [dgeni](https://github.com/angular/dgeni) tool to convert these files into docs that can be viewed in the doc-viewer. +### Generando documentos completos -The [Authors Style Guide](https://angular.io/guide/docs-style-guide) prescribes guidelines for -writing guide pages, explains how to use the documentation classes and components, and how to markup sample source code to produce code snippets. +La principal tarea para generar los documentos es `yarn docs`. Esto procesará todos los archivos fuente (API y otros), extrayendo la documentación y generando archivos JSON que pueden ser consumidos por el doc-viewer. -### Generating the complete docs +### Generación parcial de doc para editores -The main task for generating the docs is `yarn docs`. This will process all the source files (API and other), -extracting the documentation and generating JSON files that can be consumed by the doc-viewer. +La generación completa de documentos puede llevar hasta un minuto. Eso es demasiado lento para la creación y edición eficiente de documentos. -### Partial doc generation for editors +Puedes ealizar pequeños cambios en un editor inteligente que muestre un markdown con formato: +>En VS Code, _Cmd-K, V_ abre la vista previa de markdown en el panel lateral; _Cmd-B_ alterna la barra izquierda -Full doc generation can take up to one minute. That's too slow for efficient document creation and editing. +Puedes también mirar los cambios que se muestran correctamente en el doc-viewer +con un tiempo de ciclo rápido de edición / visualización. -You can make small changes in a smart editor that displays formatted markdown: ->In VS Code, _Cmd-K, V_ opens markdown preview in side pane; _Cmd-B_ toggles left sidebar +Para este propósito, usa la tarea `yarn docs-watch`, que observa los cambios en los archivos de origen y solo vuelve a procesar los archivos necesarios para generar los documentos relacionados con el archivo que ha cambiado. +Dado que esta tarea tiene accesos directos, es mucho más rápido (a menudo menos de 1 segundo) pero no producirá contenido de fidelidad completa. Por ejemplo, los enlaces a otros documentoss y ejemplos de código pueden no mostrarse correctamente. Esto se nota especialmente en los enlaces a otros documentos y en los ejemplos incrustados, que no siempre se representan correctamente. -You also want to see those changes displayed properly in the doc viewer -with a quick, edit/view cycle time. +La configuración general es la siguiente: -For this purpose, use the `yarn docs-watch` task, which watches for changes to source files and only -re-processes the files necessary to generate the docs that are related to the file that has changed. -Since this task takes shortcuts, it is much faster (often less than 1 second) but it won't produce full -fidelity content. For example, links to other docs and code examples may not render correctly. This is -most particularly noticed in links to other docs and in the embedded examples, which may not always render -correctly. - -The general setup is as follows: - -* Open a terminal, ensure the dependencies are installed; run an initial doc generation; then start the doc-viewer: +* Abrir una terminal, estar seguro que las dependencias están instaladas; ejecutar una generación inicial del doc; luego iniciar el doc-viewer: ```bash yarn setup yarn start ``` -* Open a second terminal and start watching the docs +* Abrir una segunda terminal e iniciar el observador de documentos. ```bash yarn docs-watch ``` ->Alternatively, try the consolidated `serve-and-sync` command that builds, watches and serves in the same terminal window +>Alternativamente, prueba el comando fusionado `serve-and-sync` que crea, observa y ejecuta en la misma ventana de la terminal ```bash yarn serve-and-sync ``` -* Open a browser at https://localhost:4200/ and navigate to the document on which you want to work. -You can automatically open the browser by using `yarn start -o` in the first terminal. +* Abre un navegador con la siguiente dirección https://localhost:4200/ y navega hasta el documento en el que quieras trabajar. +Puedes automáticamente abrir el navegador utilizando `yarn start -o` en la primera terminal. -* Make changes to the page's associated doc or example files. Every time a file is saved, the doc will -be regenerated, the app will rebuild and the page will reload. +* Realiza cambios en la página de documentación asociada o en los archivos de ejemplo. Cada vez que un archivo es guardado, la documentación se regenerará, la aplicación se reconstruirá y la página se volverá a cargar. -* If you get a build error complaining about examples or any other odd behavior, be sure to consult -the [Authors Style Guide](https://angular.io/guide/docs-style-guide). +*Si recibes un error de compilación acerca de los ejemplos o cualquier otro error, asegúrate de consultar las + [guías de estilo para Autores](https://angular.io/guide/docs-style-guide) para más información.