Skip to content

Commit 62f9e78

Browse files
gkatsevgkatsev
authored
docs: remove grunt and update usage of build scripts (videojs#5656)
1 parent b7aafdc commit 62f9e78

17 files changed

+58
-72
lines changed

‎COLLABORATOR_GUIDE.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -19,8 +19,8 @@
1919
* [GitHub personal access token](#github-personal-access-token)
2020
* [Deciding what type of version release](#deciding-what-type-of-version-release)
2121
* [Doing a release](#doing-a-release)
22-
* [Video.js 6](#videojs-6)
23-
* [Video.js 5](#videojs-5)
22+
* [Current Video.js](#current-videojs)
23+
* [Legacy Video.js (5)](#legacy-videojs-5)
2424
* [Edit git-semver-tags](#edit-git-semver-tags)
2525
* [And now for the release](#and-now-for-the-release)
2626
* [Deploy as a patch to the CDN](#deploy-as-a-patch-to-the-cdn)
@@ -332,7 +332,7 @@ git clone git@github.com:videojs/video.js.git videojs-6-release
332332
git clone git@github.com:videojs/video.js.git videojs-5-release
333333
```
334334
335-
#### Video.js 6
335+
#### Current Video.js
336336
337337
Make sure go to the master branch and grab the latest updates.
338338
@@ -378,7 +378,7 @@ you can run it manually:
378378
VJS_GITHUB_USER=gkatsev VJS_GITHUB_TOKEN=123 node build/gh-release.js --prelease
379379
```
380380
381-
#### Video.js 5
381+
#### Legacy Video.js (5)
382382
383383
Make sure to go to the 5.x branch and grab the latest updates.
384384

‎CONTRIBUTING.md

Lines changed: 2 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -97,19 +97,6 @@ To contibute code you'll need to be able to build a copy of Video.js and run tes
9797
* Node.js
9898
Video.js uses Node for build and test automation. Node is available for Windows, Mac OS X, Linux, and SunOS, as well as source code if that doesn't scare you. [Download and install Node.js](http://nodejs.org/download/)
9999

100-
* `grunt-cli`
101-
Optionally, install `grunt-cli` globally to use grunt directly. It can always be run via an npm script:
102-
103-
```sh
104-
npm run grunt
105-
```
106-
107-
```sh
108-
npm install -g grunt-cli
109-
```
110-
111-
Depending on how you have node and npm set up, you may need to run the global install (`-g`) as a superuser by prepending `sudo`.
112-
113100
### Building video.js locally
114101

115102
#### Forking and cloning the repository
@@ -199,17 +186,11 @@ This ties in nicely with the sandbox directory. You can always open the `sandbox
199186
> Flash files (`.swf`) that are local and loaded into a locally accessed page (file:///) will NOT run.
200187
> To get around this you must use a local web server.
201188
202-
To run the local webserver, you can run it in a couple of ways.
203-
204-
```sh
205-
grunt connect
206-
open http://localhost:9999/sandbox/index.html
207-
```
208-
209-
or
189+
To run the local webserver:
210190

211191
```sh
212192
npm start
193+
open http://localhost:9999/sandbox/index.html
213194
```
214195

215196
The latter does some extra work which will be described in the next section.

‎docs/guides/components.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,7 @@ The architecture of the Video.js player is centered around components. The `Play
1616
* [Using trigger](#using-trigger)
1717
* [Default Component Tree](#default-component-tree)
1818
* [Specific Component Details](#specific-component-details)
19+
* [Play Toggle](#play-toggle)
1920
* [Volume Panel](#volume-panel)
2021
* [Text Track Settings](#text-track-settings)
2122
* [Resize Manager](#resize-manager)

‎docs/guides/languages.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -60,9 +60,9 @@ Each file's name should be the [standard language code][lang-codes] that is most
6060
If there is a [missing translation](/docs/translations-needed.md), mistake, or room for improvement in an existing translation, don't hesitate to open a pull request!
6161

6262
1. Edit the relevant JSON file and make the necessary changes.
63-
1. Verify the language compiles by running `grunt dist`.
63+
1. Verify the language compiles by running the language specific build `npm run build:lang` or the full build `npm run build`.
6464
1. Verify the translation appears properly in the player UI.
65-
1. Run `grunt check-translations` to update the [missing translation document](/docs/translations-needed.md).
65+
1. Run `npm run docs:lang` to update the [missing translation document](/docs/translations-needed.md).
6666
1. Commit and open a pull request on GitHub.
6767

6868
### Writing a New Translation

‎docs/guides/layout.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -114,15 +114,15 @@ Responsive mode is independent of fluid mode or fill mode - it only deals with t
114114

115115
A player in responsive mode will add and remove classes based on its size breakpoints. The default breakpoints, classes, and sizes are outlined below:
116116

117-
Name | Class | Min. Width | Max. Width
118-
---------|----------------------|------------|-----------
119-
`tiny` | `vjs-layout-tiny` | 0 | 210
120-
`xsmall` | `vjs-layout-x-small` | 211 | 320
121-
`small` | `vjs-layout-small` | 321 | 425
122-
`medium` | `vjs-layout-medium` | 426 | 768
123-
`large` | `vjs-layout-large` | 769 | 1440
124-
`xlarge` | `vjs-layout-x-large` | 1441 | 2560
125-
`huge` | `vjs-layout-huge` | 2561 | Infinity
117+
| Name | Class | Min. Width | Max. Width |
118+
| -------- | -------------------- | ---------- | ---------- |
119+
| `tiny` | `vjs-layout-tiny` | 0 | 210 |
120+
| `xsmall` | `vjs-layout-x-small` | 211 | 320 |
121+
| `small` | `vjs-layout-small` | 321 | 425 |
122+
| `medium` | `vjs-layout-medium` | 426 | 768 |
123+
| `large` | `vjs-layout-large` | 769 | 1440 |
124+
| `xlarge` | `vjs-layout-x-large` | 1441 | 2560 |
125+
| `huge` | `vjs-layout-huge` | 2561 | Infinity |
126126

127127
### Enabling Responsive Mode
128128

‎docs/guides/options.md

Lines changed: 11 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,7 @@
2121
* [Video.js-specific Options](#videojs-specific-options)
2222
* [aspectRatio](#aspectratio)
2323
* [autoSetup](#autosetup)
24+
* [breakpoints](#breakpoints)
2425
* [children](#children)
2526
* [fluid](#fluid)
2627
* [inactivityTimeout](#inactivitytimeout)
@@ -30,6 +31,7 @@
3031
* [notSupportedMessage](#notsupportedmessage)
3132
* [playbackRates](#playbackrates)
3233
* [plugins](#plugins)
34+
* [responsive](#responsive)
3335
* [sources](#sources)
3436
* [techCanOverridePoster](#techcanoverrideposter)
3537
* [techOrder](#techorder)
@@ -171,15 +173,15 @@ When used with the [`responsive` option](#responsive), sets breakpoints that wil
171173

172174
By default, the breakpoints are:
173175

174-
Class Name | Width Range
175-
---------------------|------------
176-
`vjs-layout-tiny` | 0-210
177-
`vjs-layout-x-small` | 211-320
178-
`vjs-layout-small` | 321-425
179-
`vjs-layout-medium` | 426-768
180-
`vjs-layout-large` | 769-1440
181-
`vjs-layout-x-large` | 1441-2560
182-
`vjs-layout-huge` | 2561+
176+
| Class Name | Width Range |
177+
| -------------------- | ----------- |
178+
| `vjs-layout-tiny` | 0-210 |
179+
| `vjs-layout-x-small` | 211-320 |
180+
| `vjs-layout-small` | 321-425 |
181+
| `vjs-layout-medium` | 426-768 |
182+
| `vjs-layout-large` | 769-1440 |
183+
| `vjs-layout-x-large` | 1441-2560 |
184+
| `vjs-layout-huge` | 2561+ |
183185

184186
While the class names cannot be changed, the width ranges can be configured via an object like this:
185187

‎docs/guides/text-tracks.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ Text tracks are a feature of HTML5 for displaying time-triggered text to the end
2121
* [Text Track Precedence](#text-track-precedence)
2222
* [API](#api)
2323
* [Remote Text Tracks](#remote-text-tracks)
24-
* [Text Tracks](#text-tracks-1)
24+
* [Text Tracks](#text-tracks)
2525

2626
## A Note on "Remote" Text Tracks
2727

@@ -221,7 +221,9 @@ For more complete information, refer to the [Video.js API docs](https://docs.vid
221221
As mentioned [above](#a-note-on-remote-text-tracks), remote text tracks represent the recommended API offered by Video.js as they can be removed.
222222

223223
* `Player#remoteTextTracks()`
224+
224225
* `Player#remoteTextTrackEls()`
226+
225227
* `Player#addRemoteTextTrack(Object options)`
226228

227229
Available options are the same as the [available `track` attributes](#track-attributes). And `language` is a supported option as an alias for the `srclang` attribute - either works here.
@@ -242,11 +244,13 @@ As mentioned [above](#a-note-on-remote-text-tracks), remote text tracks represen
242244
It is generally recommended that you use _remote_ text tracks rather than these purely programmatic text tracks for the majority of use-cases.
243245

244246
* `Player#textTracks()`
247+
245248
* `Player#addTextTrack(String kind, [String label [, String language]])`
246249

247250
> **Note:** Non-remote text tracks are intended for _purely programmatic usage_ of tracks and have the important limitation that they _cannot be removed once created_.
248251
>
249252
> The standard `addTextTrack` does **not** have a corresponding `removeTextTrack` method; so, we actually discourage the use of this method!
250253
251254
* `TextTrackList()`
255+
252256
* `TextTrack()`

‎docs/translations-needed.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,7 @@ This default value is hardcoded as a default to the localize method in the SeekB
1313
## Status of translations
1414

1515
<!-- START langtable -->
16+
1617
| Language file | Missing translations |
1718
| ----------------------- | ----------------------------------------------------------------------------------- |
1819
| ar.json (missing 51) | Audio Player |
@@ -1174,4 +1175,5 @@ This default value is hardcoded as a default to the localize method in the SeekB
11741175
| | {1} is loading. |
11751176
| zh-TW.json (missing 2) | progress bar timing: currentTime={1} duration={2} |
11761177
| | {1} is loading. |
1178+
11771179
<!-- END langtable -->

‎index.html

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,10 +15,13 @@ <h2>Navigation</h2>
1515
<li><a href="sandbox/icons.html">Icons Demo</a></li>
1616
<li><a href="sandbox/focus-visible.html">Focus Visible Demo</a></li>
1717
<li><a href="sandbox/flash.html">Flash Demo</a></li>
18-
<li><a href="sandbox/fake-live.html">Fake Live Demo</a></li>
1918
<li><a href="sandbox/embeds.html">Embeds Demo</a></li>
2019
<li><a href="sandbox/descriptions.html">Descriptions Demo</a></li>
2120
<li><a href="sandbox/combined-tracks.html">Combined Tracks Demo</a></li>
21+
<li><a href="sandbox/live.html">Live Demo</a></li>
22+
<li><a href="sandbox/liveui.html">LiveUI Demo</a></li>
23+
<li><a href="sandbox/vertical-volume.html">Vertical Volume Demo</a></li>
24+
<li><a href="sandbox/language.html">Laungage Demo</a></li>
2225
</ul>
2326

2427
<h2>Simple Demo (in an iframe)</h2>

‎package.json

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -157,7 +157,6 @@
157157
},
158158
"vjsstandard": {
159159
"ignore": [
160-
"**/Gruntfile.js",
161160
"**/es5/**",
162161
"**/build/**",
163162
"!build/rollup.js",

‎sandbox/combined-tracks.html.example

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -16,10 +16,9 @@
1616
</head>
1717
<body>
1818
<div style="background-color:#eee; border: 1px solid #777; padding: 10px; margin-bottom: 20px; font-size: .8em; line-height: 1.5em; font-family: Verdana, sans-serif;">
19-
<p>You can use /sandbox/ for writing and testing your own code. Nothing in /sandbox/ will get checked into the repo, except files that end in .example (so don't edit or add those files). To get started make a copy of index.html.example and rename it to index.html.</p>
20-
<pre>cp sandbox/index.html.example sandbox/index.html</pre>
21-
<pre>npm run start</pre>
22-
<pre>open http://localhost:9999/sandbox/index.html</pre>
19+
<p>You can use /sandbox/ for writing and testing your own code. Nothing in /sandbox/ will get checked into the repo, except files that end in .example (so don't edit or add those files). To get started run `npm start` and open the combined-tracks.html</p>
20+
<pre>npm start</pre>
21+
<pre>open http://localhost:9999/sandbox/combined-tracks.html</pre>
2322
</div>
2423

2524
<video id="vid1" class="video-js" lang="en" controls preload="auto" width="640" height="360" poster="//d2zihajmogu5jn.cloudfront.net/elephantsdream/poster.png">

‎sandbox/flash.html.example

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -17,9 +17,8 @@
1717
</head>
1818
<body>
1919
<div style="background-color:#eee; border: 1px solid #777; padding: 10px; margin-bottom: 20px; font-size: .8em; line-height: 1.5em; font-family: Verdana, sans-serif;">
20-
<p>You can use /sandbox/ for writing and testing your own code. Nothing in /sandbox/ will get checked into the repo, except files that end in .example (so don't edit or add those files). To get started make a copy of index.html.example and rename it to index.html.</p>
21-
<pre>cp sandbox/flash.html.example sandbox/flash.html</pre>
22-
<pre>npm run start</pre>
20+
<p>You can use /sandbox/ for writing and testing your own code. Nothing in /sandbox/ will get checked into the repo, except files that end in .example (so don't edit or add those files). To get started run `npm start` and open the flash.html</p>
21+
<pre>npm start</pre>
2322
<pre>open http://localhost:9999/sandbox/flash.html</pre>
2423
</div>
2524

‎sandbox/focus-visible.html.example

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -16,8 +16,8 @@
1616
</head>
1717
<body>
1818
<div style="background-color:#eee; border: 1px solid #777; padding: 10px; margin-bottom: 20px; font-size: .8em; line-height: 1.5em; font-family: Verdana, sans-serif;">
19-
<p>You can use /sandbox/ for writing and testing your own code. Nothing in /sandbox/ will get checked into the repo, except files that end in .example (so don't edit or add those files). To get started make a copy of index.html.example and rename it to index.html.</p>
20-
<pre><b>npm start</b> will automatically copy these files over from .example if they don't already exist.</pre>
19+
<p>You can use /sandbox/ for writing and testing your own code. Nothing in /sandbox/ will get checked into the repo, except files that end in .example (so don't edit or add those files). To get started run `npm start` and open the focus-visible.html</p>
20+
<pre>npm start</pre>
2121
<pre>open http://localhost:9999/sandbox/focus-visible.html</pre>
2222
</div>
2323

‎sandbox/index.html.example

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -8,9 +8,8 @@
88
</head>
99
<body>
1010
<div style="background-color:#eee; border: 1px solid #777; padding: 10px; margin-bottom: 20px; font-size: .8em; line-height: 1.5em; font-family: Verdana, sans-serif;">
11-
<p>You can use /sandbox/ for writing and testing your own code. Nothing in /sandbox/ will get checked into the repo, except files that end in .example (so don't edit or add those files). To get started make a copy of index.html.example and rename it to index.html.</p>
12-
<pre>cp sandbox/index.html.example sandbox/index.html</pre>
13-
<pre>npm run start</pre>
11+
<p>You can use /sandbox/ for writing and testing your own code. Nothing in /sandbox/ will get checked into the repo, except files that end in .example (so don't edit or add those files). To get started run `npm start` and open the index.html</p>
12+
<pre>npm start</pre>
1413
<pre>open http://localhost:9999/sandbox/index.html</pre>
1514
</div>
1615

‎sandbox/live.html.example

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -8,10 +8,9 @@
88
</head>
99
<body>
1010
<div style="background-color:#eee; border: 1px solid #777; padding: 10px; margin-bottom: 20px; font-size: .8em; line-height: 1.5em; font-family: Verdana, sans-serif;">
11-
<p>You can use /sandbox/ for writing and testing your own code. Nothing in /sandbox/ will get checked into the repo, except files that end in .example (so don't edit or add those files). To get started make a copy of index.html.example and rename it to index.html.</p>
12-
<pre>cp sandbox/index.html.example sandbox/index.html</pre>
13-
<pre>npm run start</pre>
14-
<pre>open http://localhost:9999/sandbox/index.html</pre>
11+
<p>You can use /sandbox/ for writing and testing your own code. Nothing in /sandbox/ will get checked into the repo, except files that end in .example (so don't edit or add those files). To get started run `npm start` and open the live.html</p>
12+
<pre>npm start</pre>
13+
<pre>open http://localhost:9999/sandbox/live.html</pre>
1514
</div>
1615

1716
<video-js id="vid1" controls preload="auto" width="640" height="264">

‎sandbox/liveui.html.example

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -8,10 +8,9 @@
88
</head>
99
<body>
1010
<div style="background-color:#eee; border: 1px solid #777; padding: 10px; margin-bottom: 20px; font-size: .8em; line-height: 1.5em; font-family: Verdana, sans-serif;">
11-
<p>You can use /sandbox/ for writing and testing your own code. Nothing in /sandbox/ will get checked into the repo, except files that end in .example (so don't edit or add those files). To get started make a copy of index.html.example and rename it to index.html.</p>
12-
<pre>cp sandbox/index.html.example sandbox/index.html</pre>
13-
<pre>npm run start</pre>
14-
<pre>open http://localhost:9999/sandbox/index.html</pre>
11+
<p>You can use /sandbox/ for writing and testing your own code. Nothing in /sandbox/ will get checked into the repo, except files that end in .example (so don't edit or add those files). To get started run `npm start` and open the liveui.html</p>
12+
<pre>npm start</pre>
13+
<pre>open http://localhost:9999/sandbox/liveui.html</pre>
1514
</div>
1615

1716
<video-js id="vid1" controls preload="auto" width="640" height="264">

‎sandbox/vertical-volume.html.example

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -8,10 +8,9 @@
88
</head>
99
<body>
1010
<div style="background-color:#eee; border: 1px solid #777; padding: 10px; margin-bottom: 20px; font-size: .8em; line-height: 1.5em; font-family: Verdana, sans-serif;">
11-
<p>You can use /sandbox/ for writing and testing your own code. Nothing in /sandbox/ will get checked into the repo, except files that end in .example (so don't edit or add those files). To get started make a copy of index.html.example and rename it to index.html.</p>
12-
<pre>cp sandbox/index.html.example sandbox/index.html</pre>
13-
<pre>npm run start</pre>
14-
<pre>open http://localhost:9999/sandbox/index.html</pre>
11+
<p>You can use /sandbox/ for writing and testing your own code. Nothing in /sandbox/ will get checked into the repo, except files that end in .example (so don't edit or add those files). To get started run `npm start` and open the vertical-volume.html</p>
12+
<pre>npm start</pre>
13+
<pre>open http://localhost:9999/sandbox/vertical-volume.html</pre>
1514
</div>
1615

1716
<video-js

0 commit comments

Comments
 (0)