Skip to content

Commit b91a10a

Browse files
authored
s/mithril/mithril@next/g, add v1 docs link [skip ci] (MithrilJS#2368)
This should help point users to the correct version if they plan to install the release candidate, and it should help users find the existing docs for v1.
1 parent 722a4f4 commit b91a10a

File tree

6 files changed

+27
-18
lines changed

6 files changed

+27
-18
lines changed

README.md

+3
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,10 @@ Mithril supports IE11, Firefox ESR, and the last two versions of Firefox, Edge,
3636

3737
### npm
3838
```bash
39+
# For the most recent stable version
3940
$ npm install mithril --save
41+
# For the most recent unstable version
42+
$ npm install mithril@next --save
4043
```
4144

4245
The ["Getting started" guide](https://mithril.js.org/#getting-started) is a good place to start learning how to use mithril.

docs/index.md

+2
Original file line numberDiff line numberDiff line change
@@ -46,6 +46,8 @@ If you are an experienced developer and want to know how Mithril compares to oth
4646

4747
Mithril supports IE11, Firefox ESR, and the last two versions of Firefox, Edge, Safari, and Chrome. No polyfills required.
4848

49+
*Looking for the v1 docs? [Click here](archive/v1.1.6).*
50+
4951
---
5052

5153
### Getting started

docs/installation.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ If you're new to Javascript or just want a very simple setup to get your feet we
1818
### NPM
1919

2020
```bash
21-
$ npm install mithril --save
21+
$ npm install mithril@next --save
2222
```
2323

2424
---
@@ -32,7 +32,7 @@ $ npm init --yes
3232

3333
2. install required tools
3434
```bash
35-
$ npm install mithril --save
35+
$ npm install mithril@next --save
3636
$ npm install webpack webpack-cli --save-dev
3737
```
3838

@@ -83,7 +83,7 @@ npm init --yes
8383
Then, to install Mithril, run:
8484

8585
```bash
86-
npm install mithril --save
86+
npm install mithril@next --save
8787
```
8888

8989
This will create a folder called `node_modules`, and a `mithril` folder inside of it. It will also add an entry under `dependencies` in the `package.json` file
@@ -206,7 +206,7 @@ Live reload is a feature where code changes automatically trigger the page to re
206206

207207
```bash
208208
# 1) install
209-
npm install mithril --save
209+
npm install mithril@next --save
210210
npm install budo -g
211211

212212
# 2) add this line into the scripts section in package.json

docs/nav-guides.md

+1
Original file line numberDiff line numberDiff line change
@@ -26,3 +26,4 @@
2626
- Misc
2727
- [Framework comparison](framework-comparison.md)
2828
- [Change log/Migration](change-log.md)
29+
- [v1 Documentation](archive/v1.1.6)

docs/releasing.md

+15-12
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,8 @@ $ git pull --rebase mithriljs next
1919

2020
2. Determine patch level of the change
2121
3. Update information in `docs/change-log.md` to match reality of the new version being prepared for release
22-
4. Commit changes to `next`
22+
4. Replace all existing references to `mithril@next` to `mithril` if moving from a release candidate to stable.
23+
5. Commit changes to `next`
2324

2425
```
2526
$ git add .
@@ -34,20 +35,20 @@ $ git push mithriljs next
3435

3536
### Merge from `next` to `master`
3637

37-
5. Switch to `master` and make sure it's up to date
38+
6. Switch to `master` and make sure it's up to date
3839

3940
```bash
4041
$ git checkout master
4142
$ git pull --rebase mithriljs master
4243
```
4344

44-
6. merge `next` on top of it
45+
7. merge `next` on top of it
4546

4647
```bash
4748
$ git merge next
4849
```
4950

50-
7. Clean & update npm dependencies and ensure the tests are passing.
51+
8. Clean & update npm dependencies and ensure the tests are passing.
5152

5253
```bash
5354
$ npm prune
@@ -57,34 +58,34 @@ $ npm test
5758

5859
### Publish the release
5960

60-
8. `npm run release <major|minor|patch|semver>`, see the docs for [`npm version`](https://docs.npmjs.com/cli/version)
61-
9. The changes will be automatically pushed to your fork
62-
10. Push the changes to `MithrilJS/mithril.js`
61+
9. `npm run release <major|minor|patch|semver>`, see the docs for [`npm version`](https://docs.npmjs.com/cli/version)
62+
10. The changes will be automatically pushed to your fork
63+
11. Push the changes to `MithrilJS/mithril.js`
6364

6465
```bash
6566
$ git push mithriljs master
6667
```
6768

68-
11. Travis will push the new release to npm & create a GitHub release
69+
12. Travis will push the new release to npm & create a GitHub release
6970

7071
### Merge `master` back into `next`
7172

7273
This helps to ensure that the `version` field of `package.json` doesn't get out of date.
7374

74-
12. Switch to `next` and make sure it's up to date
75+
13. Switch to `next` and make sure it's up to date
7576

7677
```bash
7778
$ git checkout next
7879
$ git pull --rebase mithriljs next
7980
```
8081

81-
13. Merge `master` back onto `next`
82+
14. Merge `master` back onto `next`
8283

8384
```bash
8485
$ git merge master
8586
```
8687

87-
14. Push the changes to your fork & `MithrilJS/mithril.js`
88+
15. Push the changes to your fork & `MithrilJS/mithril.js`
8889

8990
```bash
9091
$ git push
@@ -93,7 +94,7 @@ $ git push mithriljs next
9394

9495
### Update the GitHub release
9596

96-
15. The GitHub Release will require a manual description & title to be added. I suggest coming up with a fun title & then copying the `docs/change-log.md` entry for the build.
97+
16. The GitHub Release will require a manual description & title to be added. I suggest coming up with a fun title & then copying the `docs/change-log.md` entry for the build.
9798

9899
## Updating mithril.js.org
99100

@@ -117,6 +118,8 @@ $ git push mithriljs
117118

118119
After the Travis build completes the updated docs should appear on https://mithril.js.org in a few minutes.
119120

121+
**Note:** When updating the stable version with a release candidate out, ***make sure to update the index + navigation to point to the new stable version!!!***
122+
120123
## Releasing a new ospec version
121124

122125
1. Ensure your local branch is up to date

docs/stream.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -46,10 +46,10 @@ var Stream = require("mithril/stream")
4646
You can also download the module directly if your environment does not support a bundling toolchain:
4747

4848
```markup
49-
<script src="https://unpkg.com/mithril-stream"></script>
49+
<script src="https://unpkg.com/mithril@next/stream"></script>
5050
```
5151

52-
When loaded directly with a `<script>` tag (rather than required), the stream library will be exposed as `window.m.stream`. If `window.m` is already defined (e.g. because you also use the main Mithril script), it will attach itself to the existing object. Otherwise it creates a new `window.m`. If you want to use streams in conjunction with Mithril as raw script tags, you should include Mithril in your page before `mithril-stream`, because `mithril` will otherwise overwrite the `window.m` object defined by `mithril-stream`. This is not a concern when the libraries are consumed as CommonJS modules (using `require(...)`).
52+
When loaded directly with a `<script>` tag (rather than required), the stream library will be exposed as `window.m.stream`. If `window.m` is already defined (e.g. because you also use the main Mithril script), it will attach itself to the existing object. Otherwise it creates a new `window.m`. If you want to use streams in conjunction with Mithril as raw script tags, you should include Mithril in your page before `mithril/stream`, because `mithril` will otherwise overwrite the `window.m` object defined by `mithril-stream`. This is not a concern when the libraries are consumed as CommonJS modules (using `require(...)`).
5353

5454
---
5555

0 commit comments

Comments
 (0)