Skip to content

Commit 42f3219

Browse files
authored
Merge pull request #247 from chaitanya1731/documentation-release
Readme: Update root readme markdown formatting
2 parents 2ab7ce6 + 79b8410 commit 42f3219

File tree

1 file changed

+17
-17
lines changed

1 file changed

+17
-17
lines changed

README.md

Lines changed: 17 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
# Intel® Technology Enabling for OpenShift*
2-
# Overview
2+
## Overview
33
The Intel Technology Enabling for OpenShift project provides Intel Data Center hardware feature-provisioning technologies with the [Red Hat OpenShift Container Platform (RHOCP)](https://www.redhat.com/en/technologies/cloud-computing/openshift/container-platform). The technology to deploy and manage the End-to-End (E2E) solutions as well as the related reference workloads for these features are also included in the project.
44

55
These Intel Data Center hardware features currently include:
@@ -26,64 +26,64 @@ Figure-1 is the [Architecture and Working Scope](https://github.com/intel/intel-
2626
</div>
2727

2828

29-
# Supported platforms
29+
## Supported platforms
3030

3131
This [section](/docs/supported_platforms.md) describes the RHOCP infrastructure and Intel hardware features supported by this project. The project lifecycle and support channels can also be found [here](docs/supported_platforms.md#support).
3232

33-
# Getting started
33+
## Getting started
3434
See reference [BIOS Configuration](/docs/supported_platforms.md#bios-configuration) required for each feature.
35-
## Provisioning RHOCP cluster
35+
### Provisioning RHOCP cluster
3636
Use one of these two options to provision an RHOCP cluster:
3737
- Use the methods introduced in [RHOCP documentation](https://docs.openshift.com/container-platform/4.14/installing/index.html).
3838
- Use [Distributed CI](https://doc.distributed-ci.io/) as we do in this project.
3939

4040
In this project, we provisioned RHOCP 4.14 on a bare-metal multi-node cluster. For details about the supported RHOCP infrastructure, see the [Supported Platforms](/docs/supported_platforms.md) page.
4141

42-
## Provisioning Intel hardware features on RHOCP
42+
### Provisioning Intel hardware features on RHOCP
4343
Please follow the steps below to provision the hardware features
4444
1. Setting up [Node Feature Discovery](/nfd/README.md)
4545
2. Setting up [Machine Configuration](/machine_configuration/README.md)
4646
3. Setting up [Out of Tree Drivers](/kmmo/README.md)
4747
4. Setting up [Device Plugins](/device_plugins/README.md)
4848

49-
## Verifying hardware feature provisioning
49+
### Verifying hardware feature provisioning
5050
You can use the instructions in the [link](/tests/l2/README.md) to verify the hardware features provisioning.
5151

52-
# Upgrade (To be added)
52+
## Upgrade (To be added)
5353

54-
# Reference end-to-end solution
54+
## Reference end-to-end solution
5555
The reference end-to-end solution is based on Intel hardware feature provisioning provided by this project.
5656

5757
[Intel AI Inferencing Solution](/e2e/inference/README.md) with [OpenVINO](https://github.com/openvinotoolkit/openvino) and [RHOAI](https://www.redhat.com/en/technologies/cloud-computing/openshift/openshift-data-science)
5858

59-
# Reference workloads
59+
## Reference workloads
6060
Here are some reference workloads built on the end-to-end solution and Intel hardware feature provisioning in this project.
6161
- Large Language Model (To be added)
6262
- Open Federated Learning (To be added)
6363

64-
# Advanced Guide
64+
## Advanced Guide
6565
This section discusses architecture and other technical details that go beyond getting started.
6666
- [Architecture and Working Scope](https://github.com/intel/intel-technology-enabling-for-openshift/wiki/Intel-Technology-Enabling-for-OpenShift-Architecture-and-Working-Scope)
6767

68-
# Release Notes
68+
## Release Notes
6969
Check the [link](https://github.com/intel/intel-technology-enabling-for-openshift/releases/) for the Release Notes.
7070

71-
# Support
71+
## Support
7272
If users encounter any issues or have questions regarding Intel Technology Enabling for OpenShift, we recommend them to seek support through the following channels:
7373
### Commercial support from Red Hat
7474
This project relies on features developed and released with the latest RHOCP release. 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.
7575

76-
### Open-Source Community Support
76+
#### Open-Source Community Support
7777
Intel Technology Enabling for OpenShift is run as an open-source project on GitHub. Project GitHub [issues](https://github.com/intel/intel-technology-enabling-for-openshift/issues) can be used as the primary support interface for users to submit feature requests and report issues to the community when using Intel technology provided by this project. Please provide detailed information about your issue and steps to reproduce it, if possible.
7878

79-
# Contribute
79+
## Contribute
8080
See [CONTRIBUTING](CONTRIBUTING.md) for more information.
8181

82-
# Security
82+
## Security
8383
To report a potential security vulnerability, please refer to [security.md](/security.md) file.
8484

85-
# License
85+
## License
8686
Distributed under the open source license. See [LICENSE](/LICENSE.txt) for more information.
8787

88-
# Code of Conduct
88+
## Code of Conduct
8989
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.

0 commit comments

Comments
 (0)