Changes for project and developer documentation

CONTRIBUTING.md

@@ -4,61 +4,22 @@ layout: default
 
 # Join the community
 
-* Chat: We have an active [community chat on Gitter](https://gitter.im/JanssenProject/Lobby). You can register for free their with your Github identity.
-* Tweet: Janssen is on [Twitter](https://twitter.com/janssen_project) too. Follow us there to stay up to date on release announcements and news around Janssen.
-* Email: We have an active mailing list also.
-* Google group : You can subscribe to the [Janssen Google Group](https://groups.google.com/u/2/g/janssen_project)
+* **Chat**: We have an active [community chat on Gitter](https://gitter.im/JanssenProject/Lobby). You can register for free their with your Github identity.
+* **Tweet**: Janssen is on [Twitter](https://twitter.com/janssen_project) too. Follow us there to stay up to date on release announcements and news around Janssen.
+* **Email**: We have an active mailing list also.
+* **Google group** : You can subscribe to the [Janssen Google Group](https://groups.google.com/u/2/g/janssen_project)
   and post messages there.
 
 # Contribute
 
-Please go through our [contribution guidelines](#contribution-guidelines) so it'll be easy for you to make successful contributions.
+Please go through Janssen [contribution guidelines](#contribution-guidelines) so it'll be easy for you to make successful contributions.
 
-In case you are _**first-time**_ contributor, then you can start with our [good first issues list](https://github.com/JanssenProject/home/labels/good%20first%20issue) These are issues where you can easily contribute and community members will guide and support your contribution as always.
+In case you are _**first-time**_ contributor, then you can start with Janssen [good first issues list](https://github.com/JanssenProject/home/labels/good%20first%20issue) These are issues where you can easily contribute and community members will guide and support your contribution as always.
 
-If you need Janssen installation to test out your fix, here are the [steps](#janssen-quick-install).
+Janssen [workspace setup guide](development.md) will help you setup your workspace where you can build and test your code changes.
 
 There are many ways of contributing to Janssen. And it is not just limited to fixing issues and raising pull requests. Janssen welcomes you to [raise issues](#issues), respond to queries, suggest new features, tell us your experience with Janssen, be it good or bad. All these are contributions towards making Janssen better.
 
-# Janssen quick install
-
-Try first, ask questions later? Here's how to deploy Janssen
-
-## Option 1: Cloud Native with microk8s
-
-Start a fresh ubuntu `18.04` or `20.04` and execute the following
-
- ```
- sudo su -
- wget https://raw.githubusercontent.com/JanssenProject/jans-cloud-native/master/automation/startdemo.sh && chmod u+x startdemo.sh && ./startdemo.sh
- ```
-
-This will install docker, microk8s, helm and Janssen with the default settings can be found inside [values.yaml](https://github.com/JanssenProject/jans-cloud-native/blob/master/charts/jans/values.yaml). Please map the `ip` of the instance running ubuntu to `demoexample.jans.io` and then access the endpoints at your browser such in the example in the table below. Also see [instructions for Amazon EKS](https://janssenproject.github.io/jans-cloud-native/charts/jans/)
-
-|Service           | Example endpoint                                                       |   
-|------------------|------------------------------------------------------------------------|
-|Auth server       | `https://demoexample.jans.io/.well-known/openid-configuration`         |
-|fido2             | `https://demoexample.jans.io/.well-known/fido2-configuration`          |
-|scim              | `https://demoexample.jans.io/.well-known/scim-configuration`           |   
-
-
-## Option 2: VM installation
-
-To install:
-
-```
-# curl https://raw.githubusercontent.com/JanssenProject/jans-setup/master/install.py > install.py
-# python3 install.py
-```
-
-To uninstall, run the script again with the `-uninstall` argument:
-
-```
-# python3 install.py -uninstall
-```
-
-## Option 3: You can [build jans-auth server](./development.md).
-
 
 # Contribution guidelines
 
@@ -73,7 +34,6 @@ We are really glad you are reading this, because we need volunteer developers to
   - [Commit convention](#commit-convention)
     - [Rule type](#rule-type)
 - [Coding Guidelines](#coding-guidelines)
-  - [C++](#c)
 - [Developer Certificate Of Origin](#developer-certificate-of-origin)
 
 ## Code of Conduct
@@ -92,15 +52,30 @@ We also run monthly **community calls** which are open calls to discuss Janssen
 
 ## Issues
 
-There are four kinds of issues you can open:
+There are different kinds of issues you can open:
+
+- **Bug report**:
+
+  You believe you found a problem in a project and you want to discuss and get it fixed,
+  creating an issue this type is the best way to do so. 
+
+- **Development item**:
+
+  This type of issue provides tracking mechanism for development effort. It should be opened by developers who want to contribute code to Janssen. It has checklist driven approach that helps developers make high-quality contributions. 
 
-- Bug report: you believe you found a problem in a project and you want to discuss and get it fixed,
-  creating an issue with the **bug report template** is the best way to do so.
-- Enhancement: any kind of new feature need to be discussed in this kind of issue, do you want a new rule or a new feature? This is the kind of issue you want to open. Be very good at explaining your intent, it's always important that others can understand what you mean in order to discuss, be open and collaborative in letting others help you getting this done!
-- Vulnerability: If you identify a security problem, please report it immediately, providing details about the nature, and if applicable, how to reproduce it. If you want to report an issue privately, you can email [email protected]
-- Failing tests: you noticed a flaky test or a problem with a build? This is the kind of issue to triage that!
+- **Feature request**: 
 
-The best way to get **involved** in the project is through issues, you can help in many ways:
+  Any kind of new feature need to be discussed. do you want a new rule or a new feature? This is the kind of issue you want to open. Be very good at explaining your intent, it's always important that others can understand what you mean in order to discuss, be open and collaborative in letting others help you getting this done! 
+
+- **Failing tests**: 
+
+  You noticed a flaky test or a problem with a build? This is the kind of issue to triage that!
+
+- **Report a security vulnerability**: 
+
+  If you find a security vulnerability, please share it with Janssen team by following steps as mentioned in [Janssen security policy](https://github.com/JanssenProject/.github/blob/main/SECURITY.md#security-policy). 
+
+The best way to get **involved** is through issues. Here you can help in many ways:
 
 - Issues triaging: participating in the discussion and adding details to open issues is always a good thing,
   sometimes issues need to be verified, you could be the one writing a test case to fix a bug!
@@ -128,7 +103,7 @@ These guidelines are not set in stone and are subject to change.
 
 Anyway a `kind/*` label for any issue is mandatory.
 
-This is the current [label set](https://github.com/falcosecurity/falco/labels) we have.
+This is the current [label set](https://github.com/JanssenProject/home/labels) we have.
 
 You can use commands - eg., `/label <some-label>` to add (or remove) labels or manually do it.
 
@@ -211,6 +186,3 @@ Git even has a `-s` command line option to append this automatically to your com
 $ git commit -s -m 'This is my commit message'
 ```
 
-
-# Reference links
-

README.md

@@ -7,7 +7,29 @@
 
 Janssen enables organizations to build a scalable centralized authentication and authorization service using free open source software. The components of the project today include implementations of the OAuth, OpenID Connect and FIDO standards. New components may be added as the technology evolves.
 
-# Quick links
+# Get started with quick install
 
-- [Contributing](CONTRIBUTING.md)
-- [Documentation](https://ossdhaval.github.io/docs/)
+Start a fresh ubuntu `18.04` or `20.04` and execute the following
+
+ ```
+ sudo su -
+ wget https://raw.githubusercontent.com/JanssenProject/jans-cloud-native/master/automation/startdemo.sh && chmod u+x startdemo.sh && ./startdemo.sh
+ ```
+
+This will install docker, microk8s, helm and Janssen with the default settings can be found inside [values.yaml](https://github.com/JanssenProject/jans-cloud-native/blob/master/charts/jans/values.yaml). Please map the `ip` of the instance running ubuntu to `demoexample.jans.io` and then access the endpoints at your browser such in the example in the table below. Also see [instructions for Amazon EKS](https://janssenproject.github.io/jans-cloud-native/charts/jans/)
+
+|Service           | Example endpoint                                                       |   
+|------------------|------------------------------------------------------------------------|
+|Auth server       | `https://demoexample.jans.io/.well-known/openid-configuration`         |
+|fido2             | `https://demoexample.jans.io/.well-known/fido2-configuration`          |
+|scim              | `https://demoexample.jans.io/.well-known/scim-configuration`           |   
+
+What you just installed is Cloud Native Janssen with microk8s. Explore [different ways](https://janssenproject.github.io/docs/source/installation-guide/) to install and deploy Janssen to suite you needs in production. 
+
+# Get to know Janssen
+
+Learn more and in-depth about Janssen features and module using [documentation](https://janssenproject.github.io/docs/)
+
+# Contribute
+
+Want to contribute? Our [Contribution](CONTRIBUTING.md) guide will get you started