Skip to content

Commit 5f175a8

Browse files
committed
update the contribution guide
1 parent 6438762 commit 5f175a8

File tree

1 file changed

+14
-13
lines changed

1 file changed

+14
-13
lines changed

CONTRIBUTING.md

Lines changed: 14 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -3,35 +3,36 @@
33
The sources of this tutorial docs is split across multiple repositories:
44

55
- The root repository which integrates all other module repositories to build the tutorial site:
6-
http://github.com/redhat-developer-demos/knative-tutorial.git
6+
<http://github.com/redhat-developer-demos/knative-tutorial.git>
77

8-
- Setup and Knative Serving:
9-
http://github.com/redhat-developer-demos/knative-tutorial-module-serving.git
8+
## Tutorial Modules
109

11-
- Knative Eventing:
12-
http://github.com/redhat-developer-demos/knative-tutorial-module-eventing.git
10+
- [Setup](https://github.com/redhat-developer-demos/knative-tutorial/tree/master/documentation/modules/setup)
1311

14-
- Camel-K based Enterprise Integration chapters:
15-
http://github.com/redhat-developer-demos/knative-tutorial-module-camelk.git
12+
- [Knative Serving](https://github.com/redhat-developer-demos/knative-tutorial/tree/master/documentation/modules/serving)
1613

17-
- Advanced Integration:
18-
http://github.com/redhat-developer-demos/knative-tutorial-module-advanced.git
14+
- [Knative Eventing](https://github.com/redhat-developer-demos/knative-tutorial/tree/master/documentation/modules/eventing)
15+
16+
- [Camel-K](https://github.com/redhat-developer-demos/knative-tutorial/tree/master/documentation/modules/camelk)
17+
18+
- [Advanced Topics](https://github.com/redhat-developer-demos/knative-tutorial/tree/master/documentation/modules/advanced)
1919

2020
## Running site in development mode
2121

2222
To run the site in development mode you need to have [yarn](https://yarnpkg.com) or [npm](https://nodejs.org/en/) installed with [nodejs](https://nodejs.org) v12.x or above.
2323

2424
After cloning the repositories, you can run the `yarn install` or `npm install` from the `knative-tutorial` repository to install needed nodejs packages.
2525

26-
Start the development site using `yarn run dev` or `npm run dev` command, this should open a local development site in http://localhost:3000.
26+
Start the development site using `gulp -s $PWD` that should make the a local development site available at <http://localhost:3000>.
2727

2828
Making any changes to your local repositories above cloned earlier, will be automatically built and the development site gets reloaded automatically.
2929

3030
## Send your contribution
3131

32-
Now you are all set,
33-
- Open an Issue in http://github.com/redhat-developer-demos/knative-tutorial.git
32+
Now you are all set,
33+
34+
- Open an Issue in <http://github.com/redhat-developer-demos/knative-tutorial.git>
3435
- Prepare your changes in the respective documentation repository
3536
- Send the PR to respective repositories listed above
3637

37-
We try to follow the Git commit messages using http://karma-runner.github.io/4.0/dev/git-commit-msg.html and thats not a hard rule ;)
38+
We try to follow the Git commit messages using <http://karma-runner.github.io/4.0/dev/git-commit-msg.html> and thats not a hard rule ;)

0 commit comments

Comments
 (0)