Skip to content

Commit

Permalink
update the contribution guide
Browse files Browse the repository at this point in the history
  • Loading branch information
kameshsampath committed Nov 12, 2020
1 parent 6438762 commit 5f175a8
Showing 1 changed file with 14 additions and 13 deletions.
27 changes: 14 additions & 13 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,35 +3,36 @@
The sources of this tutorial docs is split across multiple repositories:

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

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

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

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

- Advanced Integration:
http://github.com/redhat-developer-demos/knative-tutorial-module-advanced.git
- [Knative Eventing](https://github.com/redhat-developer-demos/knative-tutorial/tree/master/documentation/modules/eventing)

- [Camel-K](https://github.com/redhat-developer-demos/knative-tutorial/tree/master/documentation/modules/camelk)

- [Advanced Topics](https://github.com/redhat-developer-demos/knative-tutorial/tree/master/documentation/modules/advanced)

## Running site in development mode

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.

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

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

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

## Send your contribution

Now you are all set,
- Open an Issue in http://github.com/redhat-developer-demos/knative-tutorial.git
Now you are all set,

- Open an Issue in <http://github.com/redhat-developer-demos/knative-tutorial.git>
- Prepare your changes in the respective documentation repository
- Send the PR to respective repositories listed above

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 ;)
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 comments on commit 5f175a8

Please sign in to comment.