Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore: remove deprecated IE polyfills #6912

Merged
merged 1 commit into from
Apr 19, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
84 changes: 43 additions & 41 deletions docs_app/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,33 +2,31 @@

Everything in this folder is part of the documentation project. This includes

* 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 web site for displaying the documentation
- the dgeni configuration for converting source files to rendered files that can be viewed in the web site.

## Developer tasks

We use `npm` to manage the dependencies and to run build tasks.
You should run all these tasks from the `rxjs/docs_app` folder.
Here are the most important tasks you might need to use:

* `npm install` - install all the dependencies.
* `npm run setup` - install all the dependencies and run dgeni on the docs.
- `npm install` - install all the dependencies.
- `npm run setup` - install all the dependencies and run dgeni on the docs.

* `npm run build` - create a production build of the application (after installing dependencies, etc).
- `npm run build` - create a production build of the application (after installing dependencies, etc).

* `npm start` - run a development web server that watches the files; then builds the doc-viewer and reloads the page, as necessary.
* `npm run serve-and-sync` - run both the `docs-watch` and `start` in the same console.
* `npm run lint` - check that the doc-viewer code follows our style rules.
* `npm test` - watch all the source files, for the doc-viewer, and run all the unit tests when any change.
* `npm test -- --watch=false` - run all the unit tests once.
* `npm run e2e` - run all the e2e tests for the doc-viewer.
- `npm start` - run a development web server that watches the files; then builds the doc-viewer and reloads the page, as necessary.
- `npm run serve-and-sync` - run both the `docs-watch` and `start` in the same console.
- `npm run lint` - check that the doc-viewer code follows our style rules.
- `npm test` - watch all the source files, for the doc-viewer, and run all the unit tests when any change.
- `npm test -- --watch=false` - run all the unit tests once.
- `npm run e2e` - run all the e2e tests for the doc-viewer.

* `npm run docs` - generate all the docs from the source files.
* `npm run docs-watch` - watch the RxJS source and the docs files and run a short-circuited doc-gen for the docs that changed (don't work properly at the moment).
* `npm run docs-lint` - check that the doc gen code follows our style rules.
* `npm run docs-test` - run the unit tests for the doc generation code.

* `npm run build-ie-polyfills` - generates a js file of polyfills that can be loaded in Internet Explorer.
- `npm run docs` - generate all the docs from the source files.
- `npm run docs-watch` - watch the RxJS source and the docs files and run a short-circuited doc-gen for the docs that changed (don't work properly at the moment).
- `npm run docs-lint` - check that the doc gen code follows our style rules.
- `npm run docs-test` - run the unit tests for the doc generation code.

## Using ServiceWorker locally

Expand All @@ -38,30 +36,32 @@ serve the files in `dist/` with `npm run http-server -- dist -p 4200`.

## Running on Docker

The docs app (rxjs.dev) can run as a docker container.
In order to run the docs app on docker, use the following commands (**run from the rxjs folder**):
* `docker build -t rxjs-docs:6.4.1 .` - building the rxjs docs app image
* `docker run -p <host-port>:4200 rxjs-docs:6.4.1` - starting the container, listening on *<host-port>* for your choice.
The docs app (rxjs.dev) can run as a docker container.
In order to run the docs app on docker, use the following commands (**run from the rxjs folder**):

- `docker build -t rxjs-docs:6.4.1 .` - building the rxjs docs app image
- `docker run -p <host-port>:4200 rxjs-docs:6.4.1` - starting the container, listening on _<host-port>_ for your choice.

The container will run the documentation app with the script `start:docker` with the **stable configuration** and with 0.0.0.0 host support.
* Saving the image for later offline usage is available by building the container and then using `sudo docker save rxjs-docs:6.4.1 > <tar-name>.tar`
and loading it afterwards with `sudo docker load < <tar-name>.tar`.

- Saving the image for later offline usage is available by building the container and then using `sudo docker save rxjs-docs:6.4.1 > <tar-name>.tar`
and loading it afterwards with `sudo docker load < <tar-name>.tar`.

> tested on ubuntu 18.04.2 with Docker 18.09.4

## Guide to authoring

There are two types of content in the documentation:

* **API docs**: descriptions of the modules, classes, interfaces, etc that make up RxJS.
API docs are generated directly from the source code.
The source code is contained in TypeScript files, located in the `rxjs/src` folder.
Each API item may have a preceding comment, which contains JSDoc style tags and content.
The content is written in markdown.
- **API docs**: descriptions of the modules, classes, interfaces, etc that make up RxJS.
API docs are generated directly from the source code.
The source code is contained in TypeScript files, located in the `rxjs/src` folder.
Each API item may have a preceding comment, which contains JSDoc style tags and content.
The content is written in markdown.

* **Other content**: guides, tutorials, and other marketing material.
All other content is written using markdown in text files, located in the `rxjs/docs_app/content` folder.
More specifically, there are sub-folders that contain particular types of content: guides, tutorial and marketing.
- **Other content**: guides, tutorials, and other marketing material.
All other content is written using markdown in text files, located in the `rxjs/docs_app/content` folder.
More specifically, there are sub-folders that contain particular types of content: guides, tutorial and marketing.

### Generating the complete docs

Expand All @@ -73,7 +73,8 @@ extracting the documentation and generating JSON files that can be consumed by t
Full doc generation can take up to one minute. That's too slow for efficient document creation and editing.

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

> In VS Code, _Cmd-K, V_ opens markdown preview in side pane; _Cmd-B_ toggles left sidebar

You also want to see those changes displayed properly in the doc viewer
with a quick, edit/view cycle time.
Expand All @@ -87,32 +88,33 @@ 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:
- Open a terminal, ensure the dependencies are installed; run an initial doc generation; then start the doc-viewer:

```bash
npm run setup
npm run start
```

* Open a second terminal and start watching the docs
- Open a second terminal and start watching the docs

```bash
npm run docs-watch
```

>Alternatively, try the consolidated `serve-and-sync` command that builds, watches and serves in the same terminal window
> Alternatively, try the consolidated `serve-and-sync` command that builds, watches and serves in the same terminal window

```bash
npm run 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 `npm start -- -o` in the first terminal.
- 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 `npm start -- -o` in the first 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.
- 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.

* 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).
- 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).

## Disclaimer

Expand Down
1 change: 0 additions & 1 deletion docs_app/ngsw-config.json
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,6 @@
"resources": {
"files": [
"/assets/images/favicons/**",
"/generated/ie-polyfills.min.js",
"!/**/_unused/**"
]
}
Expand Down