George Kalpakas
7243564499
All docs examples share the same `node_modules/` (symlinked into each example from `aio/tools/examples/shared/node_modules/`). However, each example type has a different `package.json`, which comes from `aio/tools/examples/shared/boilerplate/*`). In order to ensure that the dependencies in each example's `package.json` are the same as the ones in the symlinked `node_modules/` (i.e. the ones that CI tests are run with), we have a script (`yarn run sync-deps`) that can sync dependencies from `shared/package.json` into the boilerplate `package.json` files. Previously, this script had to be run manually, which was easy to forget/not know about and resulted in the boilerplate dependencies often being out-of-sync with the ones in `shared/package.json` (and by extension, the ones that were actually installed in `node_modules/`). This commit helps keep the boilerplate dependencies up-to-date in the following ways: - Adds the `sync-deps` script to the `postinstall` scripts. This ensures that dependencies remain in sync whenever someone manually updates dependencies in `shared/package.json`. - Runs the `sync-deps` script as a Renovate post-upgrade task. This ensures that the depenencies remain in sync whenever Renovate updates dependencies in `shared/package.json`. For more info on configuring post-upgrade tasks in Renovate, see: - [postUpgradeTasks][1] - [allowedPostUpgradeCommands][2] - [allowPostUpgradeCommandTemplating][3] NOTE: For the Renovate change to take effect, the [global config][4] in `angular/dev-infra` also needs to be updated. This will be done in a separate PR. [1]: https://docs.renovatebot.com/configuration-options/#postupgradetasks [2]: https://docs.renovatebot.com/self-hosted-configuration/#allowedpostupgradecommands [3]: https://docs.renovatebot.com/self-hosted-configuration/#allowpostupgradecommandtemplating [4]: https://github.com/angular/dev-infra/blob/22d3067021130271afcfd02d063828c5bdd9c2d7/.github/ng-renovate/runner-config.js PR Close #47009
AIO project tooling
This document gives an overview of the tools that we use to generate the content for the angular.io website.
The application that actually renders this content can be found in the /aio/src folder.
The handwritten content can be found in the /aio/content folder.
Each subfolder in this /aio/tools/ folder contains a self-contained tool and its configuration. There is
a README.md file in each folder that describes the tool in more detail.
cli-patches
The AIO application is built using the Angular CLI tool. We are often trialling new features for the CLI, which we apply to the library after it is installed. This folder contains git patch files that contain these new features and a utility to apply those patches to the CLI library.
See the README.md for more details.
examples
Many of the documentation pages contain snippets of code examples. We extract these snippets from real
working example applications, which are stored in subfolders of the /aio/content/examples folder. Each
example can be built and run independently. Each example also provides e2e specs, which are run as part
of our CI build tasks, to verify that the examples continue to work as expected, as changes are made
to the core Angular libraries.
In order to build, run and test these examples independently we need to install dependencies into their sub-folder. Also there are a number of common boilerplate files that are needed to configure each example's project. We maintain these common boilerplate files centrally to reduce the amount of effort if one of them needs to change.
This examples tool folder contains three utilities:
- example-boilerplate.js - install/remove the npm dependencies and boilerplate files into/from each of the examples' subfolders.
- run-example-e2e.mjs - run the e2e tests for one or more examples
- create-example.js - create a new example from the
example-scaffold/directory or by importing files from a CLI project.
See the README.md for more details.
example-zipper
In the AIO application, we offer the reader the option to download each example as a full self-contained runnable project packaged as a zip file. These zip files are generated by the utility in this folder.
See the README.md for more details.
stackblitz-builder
In the AIO application, we can embed a running version of the example as a Stackblitz session. We can also provide a link to create a runnable version of the example in the Stackblitz editor.
See the README.md for more details.
transforms
All the content that is rendered by the AIO application, and some of its configuration files, are generated from source files by Dgeni. Dgeni is a general purpose documentation generation tool.
Markdown files in /aio/content, code comments in the core Angular source files and example files are processed and transformed into files that are consumed by the AIO application.
Dgeni is configured by "packages", which contain services and processors.
Some of these packages are installed as node_modules from the dgeni-packages and some are specific to the AIO project.
The project specific packages are stored in the aio/tools/transforms folder.
See the README.md for more details.