Merge pull request #80 from chaitanya1731/readme

Updated md in Readmes

Author: uMartinXu

README.md

@@ -1,40 +1,40 @@
 # Intel® Data Center GPU Driver for OpenShift* 
 
-# Overview
+## Overview
 The Intel Data Center GPU Driver for OpenShift project focuses on the development, packaging, certification, and release of Intel® Data Center GPU driver container images for the [Red Hat OpenShift Container Platform (RHOCP)](https://www.redhat.com/en/technologies/cloud-computing/openshift/container-platform). This project allows users to leverage the pre-built driver container image to facilitate provisioning of Intel Data Center GPU cards on an OpenShift cluster. Furthermore, users can utilize the Intel Data Center GPU driver dockerfile provided by this project as a reference for constructing their own driver container images on-premises. Intel Data Center GPU driver container images for OpenShift are certified and published on the [Red Hat Container Catalog](https://catalog.redhat.com/software/containers/intel/intel-data-center-gpu-driver-container/6495ee55c8b2461e35fb8264).
 
 The Intel Data Center GPU driver container image is built from the [Intel GPU Repository](https://github.com/intel-gpu). It includes:
 - [Intel® Graphics Driver Backports for Linux* OS (i915) for Red Hat Enterprise Linux (RHEL)](https://github.com/intel-gpu/intel-gpu-i915-backports/tree/backport/main) with Intel® Converged Security Engine (Intel® CSE) and Intel® Platform Monitoring Technology (Intel® PMT) modules
 - [Intel® GPU firmware](https://github.com/intel-gpu/intel-gpu-firmware)
 
-# Install Intel Data Center GPU Driver on RHOCP
+## Install Intel Data Center GPU Driver on RHOCP
 We recommend users use the [Kernel Module Management (KMM) operator](https://docs.openshift.com/container-platform/4.12/hardware_enablement/kmm-kernel-module-management.html) to install and manage the Intel Data Center GPU driver on RHOCP. The KMM operator can be used to deploy all the necessary driver components as well as the firmware from within the driver container image. 
 
 To install Intel Data Center GPU drivers on OpenShift using the KMM operator, please follow [pre-build mode support](https://github.com/intel/intel-technology-enabling-for-openshift/tree/main/kmmo#deploy-intel-data-center-gpu-driver-with-pre-build-mode) from the [Intel Technology Enabling for OpenShift](https://github.com/intel/intel-technology-enabling-for-openshift). 
 
 For users who prefer to create customized driver container images, the on-premises build mode is available as an option. This mode enables users to build and deploy their own container images on their OpenShift cluster.
 
-# Upgrade Intel Data Center GPU Driver with RHOCP
+## Upgrade Intel Data Center GPU Driver with RHOCP
 Upgrading of the Intel Data Center GPU drivers are supported via two scenarios: 
 - **Driver Upgrade Scenario**: This scenario is used when there is a new release from the Intel GPU Driver Repository. After the evaluation, a corresponding Intel Data Center GPU Driver container image will be built, certified, and published on the Red Hat Container Catalog. Users can make use of the KMM Operator to upgrade Intel data center GPU driver with RHOCP. 
 **Notes:** The seamless upgrade feature is still under development in Kernel Module Management project.
 - **Kernel Upgrade Scenario**: To ensure compatibility with each new Red Hat CoreOS (RHCOS) kernel used by RHOCP, the Intel GPU driver container images are re-built with the corresponding kernel version. This image is certified and then published on the Red Hat Container Catalog. KMM Operator can be used to deploy the driver container image matching the new RHCOS kernel version when upgrading the RHOCP cluster.
 
-# Support
+## Support
 If users encounter any issues or have questions regarding Intel Data Center GPU Driver with RHOCP, we recommend them to seek support through the following channels:
-## Commercial Support from Red Hat
+### Commercial Support from Red Hat
 This project facilitates provisioning pre-built Intel Data Center GPU drivers with [Intel Technology Enabling for OpenShift](https://github.com/intel/intel-technology-enabling-for-openshift) project, which are then certified and published in the Red Hat Container Catalog. Commercial RHOCP release support is outlined in the [Red Hat OpenShift Container Platform Life Cycle Policy](https://access.redhat.com/support/policy/updates/openshift) and Intel collaborates with Red Hat to address specific requirements from our users.
-## Open-Source Community Support
+### Open-Source Community Support
 Intel Data Center GPU Drivers for OpenShift is run as an open-source project on GitHub. Project GitHub [issues](https://github.com/intel/intel-data-center-gpu-driver-for-openshift/issues) related to pre-built and on-premises driver builds can be used as the primary support interface for users to submit feature requests and report issues to the community. Please provide detailed information about your issue and steps to reproduce it, if possible.
 
-# Contribute
+## Contribute
 See [CONTRIBUTING](/CONTRIBUTING.md) for more information.
 
-# License
+## License
 Distributed under the open source license. See [LICENSE](/LICENSE.txt) for more information.
 
-# Security
+## Security
 To report a potential security vulnerability, please refer to [security.md](/security.md) file.
 
-# Code of Conduct
+## Code of Conduct
 Intel has adopted the Contributor Covenant as the Code of Conduct for all of its open source projects. See [CODE_OF_CONDUCT](/CODE_OF_CONDUCT.md) file.

debug/README.md

@@ -1,38 +1,44 @@
-# Disclaimer
-Please note that this module is currently under development and may contain partially implemented features, therefore it is not supported in the current release.
+# Developers Guide
+
+> Disclaimer: Please note that this module is currently under development and may contain partially implemented features, therefore it is not supported in the current release.
 
 ## Debug Intel Data Center GPU Driver Container Image on OpenShift Cluster 
 
 To debug the driver container image, please make sure the OpenShift cluster is provisioned with Intel Data Center GPU Flex cards available on the cluster nodes. 
 
-`Notes: the following operations are verified on OCP-4.11 and OCP-4.12 cluster with Intel® Data Center GPU Flex 140`
+> Note: The following operations are verified on OCP-4.11 and OCP-4.12 cluster with Intel® Data Center GPU Flex 140
 
-### Debugging driver build 
+### Debugging Driver Build 
 Firstly, [Red Hat OCP buildconfig](https://docs.openshift.com/container-platform/4.11/cicd/builds/understanding-buildconfigs.html) is used to debug driver building process. The Dockerfile section in [driver-build.yaml](driver-build.yaml) can be updated to debug the building and packaging of the driver container Image. 
 
-- Using the below command to deploy the buildconfig and start a building process on openShift cluster. 
-
- `$ oc apply –f driver-build.yaml` 
+Using the below command to deploy the buildconfig and start a building process on openShift cluster. 
+```
+$ oc apply –f driver-build.yaml
+```
 
 If everything runs smoothly, the image created from the building process will be saved into [Red Hat OpenShift image stream](https://docs.openshift.com/container-platform/4.11/openshift_images/image-streams-manage.html), which can be used to debug the deployment of driver container image on the cluster. 
 
-### Debugging permission
+### Debugging Permission
 Before that we need to create the proper [service account](https://kubernetes.io/docs/concepts/security/service-accounts/) with the proper permission to deploy and debug the driver container image. Even now the privileged permission is used, the least permission is needed to deploy the driver. 
 
-* Using below command to create the service account with [driver-build.yaml](driver-build.yaml) 
-
- `$ oc apply –f driver-build.yaml`
-
-### Debugging driver deployment 
-* Now driver [driver-deploy.yaml](driver-deploy.yaml) can be used to deploy and debug the driver container image 
-
- `$ oc apply –f driver-deploy.yaml `
-
-### Debugging the driver
-* Below command can be used to log into the driver container to do further debugging work 
-
- `$ oc debug –n name_space pod/pod_name` 
-
-* Below command can also be used to debug the node where the driver container is running if further debugging on the work node is needed 
-
- `$ oc dbug –n name_space node/node_name` 
+Using below command to create the service account with [driver-rbac.yaml](driver-rbac.yaml) 
+```
+$ oc apply –f driver-rbac.yaml
+```
+
+### Debugging Driver Deployment 
+Now driver [driver-deploy.yaml](driver-deploy.yaml) can be used to deploy and debug the driver container image 
+```
+ $ oc apply –f driver-deploy.yaml
+```
+
+### Debugging Driver
+Below command can be used to log into the driver container to do further debugging work 
+```
+$ oc debug –n <namespace> pod/<pod_name>
+```
+
+Below command can also be used to debug the node where the driver container is running if further debugging on the work node is needed 
+```
+$ oc debug –n <namespace> node/<node_name> 
+```

release/README.md

@@ -1,24 +1,24 @@
-# Intel Data Center GPU Driver for OpenShift Release Information
+# Release Information
 
-# Overview
+## Overview
 Intel Data Center GPU driver container images for OpenShift are Red Hat certified and published on the [Red Hat Container Catalog](https://catalog.redhat.com/software/containers/intel/intel-data-center-gpu-driver-container/6495ee55c8b2461e35fb8264). These driver container images are designed to be easily managed by the KMM operator, and they follow the naming convention below.
 
-## Naming Convention
+### Naming Convention
 The driver container images in this repository use the following naming pattern:
 ![driver container image naming pattern](/release/driver-name.png)
 
-### DriverVersion 
+#### DriverVersion 
 `x.y.z` versioning pattern is used by the driver version. 
 `x`: for architecture change or major feature improvement in the driver from the Intel GPU repository. 
 `y`: for hot bug fixes or minor feature improvements in the driver from the Intel GPU repository. 
 `z`: for any improvement from this project including building or debugging updates. 
-### KernelVersion 
+#### KernelVersion 
 KernelVersion represents the full Red Hat CoreOS* (RHCOS) kernel version.
 
-## Driver Signing
+### Driver Signing
 The Intel Data Center GPU drivers in the released container images are signed for secure boot. For more details on enrolling the public key to enable secure boot with RHOCP, please seek support from Red Hat.
 
-# Release Information 
+## Releases  
 Please refer to the following table to view the detailed release information for each image.
 
 The driver containers released support the following Intel GPUs: