From d81665d05c82d0b953c45125ffce4a0fc3ec2928 Mon Sep 17 00:00:00 2001 From: Ajay Jaganathan <36824134+AjayJagan@users.noreply.github.com> Date: Thu, 30 Nov 2023 19:20:19 +0530 Subject: [PATCH] add table of contents to readme (#769) --- README.md | 22 ++++++++++++++++++++++ 1 file changed, 22 insertions(+) diff --git a/README.md b/README.md index 55f02c241c3..2fcc6f23c2b 100644 --- a/README.md +++ b/README.md @@ -3,6 +3,28 @@ This operator is the primary operator for Open Data Hub. It is responsible for e Jupyter Notebooks, Modelmesh serving, Datascience pipelines etc. The operator makes use of `DataScienceCluster` CRD to deploy and configure these applications. +### Table of contents +- [Usage](#usage) + - [Installation](#installation) +- [Dev Preview](#dev-preview) + - [Developer Guide](#developer-guide) + - [Pre-requisites](#pre-requisites) + - [Download manifests](#download-manifests) + - [Structure of `COMPONENT_MANIFESTS`](#structure-of-component_manifests) + - [Workflow](#workflow) + - [Local Storage](#local-storage) + - [Adding New Components](#adding-new-components) + - [Customizing Manifests Source](#customizing-manifests-source) + - [for local development](#for-local-development) + - [for build operator image](#for-build-operator-image) + - [Build Image](#build-image) + - [Deployment](#deployment) + - [Test with customized manifests](#test-with-customized-manifests) + - [Example DataScienceCluster](#example-datasciencecluster) + - [Run functional Tests](#run-functional-tests) + - [Run e2e Tests](#run-e2e-tests) + - [Troubleshooting](#troubleshooting) + ## Usage ### Installation