Skip to content

Commit 9513524

Browse files
chore: remove deprecated IE polyfills (#6912)
Related angular/angular#29926
1 parent 9e15d75 commit 9513524

File tree

8 files changed

+45
-404
lines changed

8 files changed

+45
-404
lines changed

docs_app/README.md

Lines changed: 43 additions & 41 deletions
Original file line numberDiff line numberDiff line change
@@ -2,33 +2,31 @@
22

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

5-
* the web site for displaying the documentation
6-
* the dgeni configuration for converting source files to rendered files that can be viewed in the web site.
5+
- the web site for displaying the documentation
6+
- the dgeni configuration for converting source files to rendered files that can be viewed in the web site.
77

88
## Developer tasks
99

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

14-
* `npm install` - install all the dependencies.
15-
* `npm run setup` - install all the dependencies and run dgeni on the docs.
14+
- `npm install` - install all the dependencies.
15+
- `npm run setup` - install all the dependencies and run dgeni on the docs.
1616

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

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

26-
* `npm run docs` - generate all the docs from the source files.
27-
* `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).
28-
* `npm run docs-lint` - check that the doc gen code follows our style rules.
29-
* `npm run docs-test` - run the unit tests for the doc generation code.
30-
31-
* `npm run build-ie-polyfills` - generates a js file of polyfills that can be loaded in Internet Explorer.
26+
- `npm run docs` - generate all the docs from the source files.
27+
- `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).
28+
- `npm run docs-lint` - check that the doc gen code follows our style rules.
29+
- `npm run docs-test` - run the unit tests for the doc generation code.
3230

3331
## Using ServiceWorker locally
3432

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

3937
## Running on Docker
4038

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

4645
The container will run the documentation app with the script `start:docker` with the **stable configuration** and with 0.0.0.0 host support.
47-
* 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`
48-
and loading it afterwards with `sudo docker load < <tar-name>.tar`.
46+
47+
- 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`
48+
and loading it afterwards with `sudo docker load < <tar-name>.tar`.
4949

5050
> tested on ubuntu 18.04.2 with Docker 18.09.4
5151
5252
## Guide to authoring
5353

5454
There are two types of content in the documentation:
5555

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

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

6666
### Generating the complete docs
6767

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

7575
You can make small changes in a smart editor that displays formatted markdown:
76-
>In VS Code, _Cmd-K, V_ opens markdown preview in side pane; _Cmd-B_ toggles left sidebar
76+
77+
> In VS Code, _Cmd-K, V_ opens markdown preview in side pane; _Cmd-B_ toggles left sidebar
7778
7879
You also want to see those changes displayed properly in the doc viewer
7980
with a quick, edit/view cycle time.
@@ -87,32 +88,33 @@ correctly.
8788

8889
The general setup is as follows:
8990

90-
* Open a terminal, ensure the dependencies are installed; run an initial doc generation; then start the doc-viewer:
91+
- Open a terminal, ensure the dependencies are installed; run an initial doc generation; then start the doc-viewer:
9192

9293
```bash
9394
npm run setup
9495
npm run start
9596
```
9697

97-
* Open a second terminal and start watching the docs
98+
- Open a second terminal and start watching the docs
9899

99100
```bash
100101
npm run docs-watch
101102
```
102103

103-
>Alternatively, try the consolidated `serve-and-sync` command that builds, watches and serves in the same terminal window
104+
> Alternatively, try the consolidated `serve-and-sync` command that builds, watches and serves in the same terminal window
105+
104106
```bash
105107
npm run serve-and-sync
106108
```
107109

108-
* Open a browser at https://localhost:4200/ and navigate to the document on which you want to work.
109-
You can automatically open the browser by using `npm start -- -o` in the first terminal.
110+
- Open a browser at https://localhost:4200/ and navigate to the document on which you want to work.
111+
You can automatically open the browser by using `npm start -- -o` in the first terminal.
110112

111-
* Make changes to the page's associated doc or example files. Every time a file is saved, the doc will
112-
be regenerated, the app will rebuild and the page will reload.
113+
- Make changes to the page's associated doc or example files. Every time a file is saved, the doc will
114+
be regenerated, the app will rebuild and the page will reload.
113115

114-
* If you get a build error complaining about examples or any other odd behavior, be sure to consult
115-
the [Authors Style Guide](https://angular.io/guide/docs-style-guide).
116+
- If you get a build error complaining about examples or any other odd behavior, be sure to consult
117+
the [Authors Style Guide](https://angular.io/guide/docs-style-guide).
116118

117119
## Disclaimer
118120

docs_app/ngsw-config.json

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,6 @@
4141
"resources": {
4242
"files": [
4343
"/assets/images/favicons/**",
44-
"/generated/ie-polyfills.min.js",
4544
"!/**/_unused/**"
4645
]
4746
}

0 commit comments

Comments
 (0)