Skip to content

Added table of contents to readme #26

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Added table of contents to readme #26

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 22 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,27 @@
# Corrino OKE Toolkit for AI/ML Workloads

## Table of Contents
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This looks awesome! Definitely helpful for how much content is on the page


1. [About Corrino](#about-corrino)
- [Problem](#problem)
- [What is Corrino and how does it help?](#what-is-corrino-and-how-does-it-help)
- [What are Recipes?](#what-are-recipes)
- [Recipe Configuration Options](#recipe-configuration-options)
- [What is in this repo?](#what-is-in-this-repo)
2. [Getting Started](#getting-started)
- [Step 1: Set up policies in tenancy](#step-1-set-up-policies-in-tenancy)
- [Step 2: Create OKE cluster](#step-2-create-oke-cluster)
- [Step 3: Install and Access Corrino](#step-3-install-and-access-corrino)
- [Step 4: Deploy a vLLM Inference recipe](#step-4-deploy-a-vllm-inference-recipe)
- [Step 5: Undeploy the recipe](#step-5-undeploy-the-recipe)
- [Additional Resources](#additional-resources)
3. [Features](#features)
4. [Ways to Access Corrino](#ways-to-access-corrino)
5. [IAM Policies](#iam-policies)
6. [Frequently asked questions](#frequently-asked-questions)
- [Cleanup](#cleanup)
8. [Questions](#questions)

## About Corrino

### Problem
Expand Down