Skip to content

Commit 369af7d

Browse files
authored
Merge pull request #140 from liferay/wincent/toolkit-v2-docs
docs(js-toolkit): update links prior to release
2 parents 04f38d3 + 032dbe0 commit 369af7d

File tree

3 files changed

+11
-28
lines changed

3 files changed

+11
-28
lines changed

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# liferay-frontend-projects monorepo
22

3-
![](https://github.com/liferay/liferay-frontend-projects/workflows/ci/badge.svg)
3+
![CI status](https://github.com/liferay/liferay-frontend-projects/workflows/ci/badge.svg)
44

55
Welcome to the monorepo of the Liferay Frontend Infrastructure team.
66

maintenance/projects/js-toolkit/CONTRIBUTING.md

Lines changed: 5 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -12,9 +12,9 @@ $ yarn ⏎
1212

1313
Which will install all needed dependencies.
1414

15-
## Repo organization
15+
## Project organization
1616

17-
The repo is a yarn workspace with several projects contained in the `packages` folder.
17+
The project is a Yarn workspace with several projects contained in the `packages` folder.
1818

1919
Other auxiliary folders are:
2020

@@ -36,15 +36,7 @@ This runs locally the same tests we run in our CI servers so that, in case anyth
3636

3737
We track all discussions and decisions in GitHub issues and PRs. We also try to explain final decisions in git commits so that they are easily available without any need to visit GitHub.
3838

39-
To maintain cross referenceability all commits must follow the [semantic commit convention](http://karma-runner.github.io/0.10/dev/git-commit-msg.html) and use `#nnn` as the first word in the subject (where `nnn` is the number of the issue associated to the commit).
40-
41-
For example:
42-
43-
```
44-
chore: #517 Fix yarn dependencies
45-
```
46-
47-
No commit may be pushed without a reference to an issue unless it is self-evident and of type `chore`.
39+
All commits must follow [our commit message guidelines](https://github.com/liferay/liferay-frontend-guidelines/blob/master/general/commit_messages.md).
4840

4941
## Tests
5042

@@ -76,7 +68,7 @@ By default, the resulting JAR file will be placed in `/opt/bundles/deploy` so ma
7668

7769
This command will download all the dependencies needed by the QA projects contained in the `qa/samples/packages` folder, and will point all JS Toolkit packages to the local project (as opposed to downloading them from npmjs.com). This is necessary since we want to use our local copy of the JS Toolkit and since we have not yet released any 3.x version, so it's impossible to download it from npmjs.com.
7870

79-
Note that the `link-js-toolkit` will move all JS Toolkit dependencies in the QA projects to a `link-js-toolkit` section in the `package.json`. This is to prevent yarn from trying to download these packages from npmjs.com.
71+
Note that the `link-js-toolkit` will move all JS Toolkit dependencies in the QA projects to a `link-js-toolkit` section in the `package.json`. This is to prevent Yarn from trying to download these packages from npmjs.com.
8072

8173
## Releasing new versions
8274

@@ -123,12 +115,10 @@ Release a new version
123115
$ yarn release ⏎
124116
```
125117

126-
Copy the relevant section from the changelog to the corresponding entry on the [releases page](https://github.com/liferay/liferay-js-toolkit/releases).
118+
Copy the relevant section from the changelog to the corresponding entry on the [releases page](https://github.com/liferay/liferay-frontend-projects/releases).
127119

128120
After the release, you may want to confirm that the packages are correctly listed in the NPM registry.
129121

130-
Finally, close [the corresponding milestone](https://github.com/liferay/liferay-js-toolkit/milestones) in GitHub.
131-
132122
## Releasing canary versions
133123

134124
Lerna offers the possibility to release canary versions, which are pre-releases published to npmjs.com but only accessible on demand (i.e., they are not automatically downloaded when dependencies are updated),
Lines changed: 5 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,12 @@
11
# liferay-js-toolkit
22

3-
[![Build Status](https://travis-ci.org/liferay/liferay-js-toolkit.svg?branch=master)](https://travis-ci.org/liferay/liferay-js-toolkit)
3+
![CI status](https://github.com/liferay/liferay-frontend-projects/workflows/ci/badge.svg)
44

55
## Setup
66

7-
1. Install NodeJS >= [v6.11.0](http://nodejs.org/dist/v6.11.0/), if you don't
8-
have it yet.
7+
1. Install NodeJS >= [v10.15.1](http://nodejs.org/dist/v10.15.1/), if you don't have it yet.
98

10-
2. Run the bootstrap script to install local dependencies and link packages
11-
together:
9+
2. Run the bootstrap script to install local dependencies and link packages together:
1210

1311
```sh
1412
yarn install
@@ -28,13 +26,8 @@ yarn test
2826

2927
## Useful resources
3028

31-
You can file any bug related to this project in the
32-
[issues page](https://github.com/liferay/liferay-js-toolkit/issues).
29+
You can file any bug related to this project in the [issues page](https://github.com/liferay/liferay-frontend-projects/issues?q=is%3Aissue+is%3Aopen+label%3Ajs-toolkit+label%3A2.x).
3330

34-
You can also get information about released versions and their changes in the
35-
[closed milestones page](https://github.com/liferay/liferay-js-toolkit/milestones?state=closed).
36-
37-
And if you want to know what's planned for the next versions, just visit the
38-
[open milestones page](https://github.com/liferay/liferay-js-toolkit/milestones?state=open).
31+
You can also get information about released versions and their changes in the [changelog](./CHANGELOG.md).
3932

4033
To finish with, you can find the most up-to-date documentation in [the project's wiki](https://github.com/liferay/liferay-js-toolkit/wiki).

0 commit comments

Comments
 (0)