From 5f175a817281f069a39cb8217f5bb26f1457f608 Mon Sep 17 00:00:00 2001 From: Kamesh Sampath Date: Thu, 12 Nov 2020 10:55:05 +0530 Subject: [PATCH] update the contribution guide --- CONTRIBUTING.md | 27 ++++++++++++++------------- 1 file changed, 14 insertions(+), 13 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 04bf7341..55e13fda 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -3,19 +3,19 @@ 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 + -- 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 @@ -23,15 +23,16 @@ To run the site in development mode you need to have [yarn](https://yarnpkg.com) 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 . 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 - 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 and thats not a hard rule ;)