From cd3d622e9539e7e33f5a4704d6e2be46981b394c Mon Sep 17 00:00:00 2001 From: codeEvolveZenith345 Date: Sun, 9 Nov 2025 20:26:31 +0000 Subject: [PATCH 1/4] feat: add an index.md for getting-started section, with accurate links and resources Signed-off-by: codeEvolveZenith345 --- docs/versioned/getting-started/index.md | 95 +++++++++++++++++++++++++ 1 file changed, 95 insertions(+) create mode 100644 docs/versioned/getting-started/index.md diff --git a/docs/versioned/getting-started/index.md b/docs/versioned/getting-started/index.md new file mode 100644 index 0000000000..3c1ec93ee1 --- /dev/null +++ b/docs/versioned/getting-started/index.md @@ -0,0 +1,95 @@ +# Getting Started with Knative + +Welcome! This guide helps you get started with Knative based on your goals and experience level. + +## What is Knative? + +Knative is a Kubernetes-based platform for deploying and managing serverless workloads. It provides components for building, deploying, and running applications that automatically scale, including scaling to zero when idle. + +## Choose Your Path + +### I want to try Knative quickly + +**Perfect for:** Developers who want hands-on experience + +Follow our step-by-step tutorial: + +1. [Install Knative locally](quickstart-install.md) - Set up using kind or minikube (10 minutes) +2. [Deploy your first service](first-service.md) - Create and test a simple application +3. [Explore autoscaling](first-autoscale.md) - See how Knative scales your app +4. [Clean up](clean-up.md) - Remove the local installation + +**Prerequisites:** Docker, kubectl, 3 CPUs, 3 GB RAM + +--- + +### I want to understand Knative first + +**Perfect for:** Evaluators and decision makers + +- [What is Knative?](which-knative.md) - Overview of components and use cases +- [About Knative Functions](about-knative-functions.md) - Simplified function development +- [Documentation overview](../README.md) - Navigate all Knative docs + +Then proceed to the [installation options](../install/) for production deployments. + +--- + +### I want to explore event-driven features + +**Perfect for:** Building event-driven applications + +1. [Getting started with Eventing](getting-started-eventing.md) - Introduction to event-driven architecture +2. [Create an event source](first-source.md) - Generate events +3. [Set up a broker](first-broker.md) - Route events to services +4. [Configure triggers](first-trigger.md) - Filter and deliver events + +--- + +### I want to build serverless functions + +**Perfect for:** Function-as-a-Service development + +1. [Install the func CLI](install-func.md) - Set up the functions CLI +2. [Create a function](create-a-function.md) - Build your first function +3. [Build and deploy](build-run-deploy-func.md) - Deploy to Knative + +--- + +## What's Next? + +After completing the getting started tutorials: + +- [Next steps](next-steps.md) - Continue your Knative journey +- [Traffic splitting](first-traffic-split.md) - Implement canary deployments +- [Code samples](../samples/) - Explore real-world examples +- [Complete tutorial](tutorial.md) - End-to-end application walkthrough + +--- + +## Components Overview + +**Knative Serving** - Deploy HTTP applications with automatic scaling and traffic management + +**Knative Eventing** - Build event-driven applications using CloudEvents + +**Knative Functions** - Create functions without managing containers or Kubernetes + +--- + +## Need Help? + +- **Slack:** [#knative-users](https://cloud-native.slack.com/) on CNCF Slack +- **Issues:** [Report problems](https://github.com/knative/docs/issues) +- **Community:** [Join working groups](../community/) + +--- + +## Installation for Production + +For production deployments, see: +- [YAML installation](../install/yaml-install/) - Direct kubectl installation +- [Operator installation](../install/operator/) - Automated lifecycle management +- [Platform-specific guides](../install/) - Cloud provider installations + +**Requirements:** Kubernetes 1.28+, cluster admin access \ No newline at end of file From c5907a9915e6d935dd820a8bf8cf83b67e0f77f3 Mon Sep 17 00:00:00 2001 From: codeEvolveZenith345 Date: Fri, 14 Nov 2025 08:28:48 +0000 Subject: [PATCH 2/4] fix: Move the index.md to tutorial.md page Signed-off-by: codeEvolveZenith345 --- docs/versioned/getting-started/index.md | 95 ---------------------- docs/versioned/getting-started/tutorial.md | 58 +++++++++++-- 2 files changed, 51 insertions(+), 102 deletions(-) delete mode 100644 docs/versioned/getting-started/index.md diff --git a/docs/versioned/getting-started/index.md b/docs/versioned/getting-started/index.md deleted file mode 100644 index 3c1ec93ee1..0000000000 --- a/docs/versioned/getting-started/index.md +++ /dev/null @@ -1,95 +0,0 @@ -# Getting Started with Knative - -Welcome! This guide helps you get started with Knative based on your goals and experience level. - -## What is Knative? - -Knative is a Kubernetes-based platform for deploying and managing serverless workloads. It provides components for building, deploying, and running applications that automatically scale, including scaling to zero when idle. - -## Choose Your Path - -### I want to try Knative quickly - -**Perfect for:** Developers who want hands-on experience - -Follow our step-by-step tutorial: - -1. [Install Knative locally](quickstart-install.md) - Set up using kind or minikube (10 minutes) -2. [Deploy your first service](first-service.md) - Create and test a simple application -3. [Explore autoscaling](first-autoscale.md) - See how Knative scales your app -4. [Clean up](clean-up.md) - Remove the local installation - -**Prerequisites:** Docker, kubectl, 3 CPUs, 3 GB RAM - ---- - -### I want to understand Knative first - -**Perfect for:** Evaluators and decision makers - -- [What is Knative?](which-knative.md) - Overview of components and use cases -- [About Knative Functions](about-knative-functions.md) - Simplified function development -- [Documentation overview](../README.md) - Navigate all Knative docs - -Then proceed to the [installation options](../install/) for production deployments. - ---- - -### I want to explore event-driven features - -**Perfect for:** Building event-driven applications - -1. [Getting started with Eventing](getting-started-eventing.md) - Introduction to event-driven architecture -2. [Create an event source](first-source.md) - Generate events -3. [Set up a broker](first-broker.md) - Route events to services -4. [Configure triggers](first-trigger.md) - Filter and deliver events - ---- - -### I want to build serverless functions - -**Perfect for:** Function-as-a-Service development - -1. [Install the func CLI](install-func.md) - Set up the functions CLI -2. [Create a function](create-a-function.md) - Build your first function -3. [Build and deploy](build-run-deploy-func.md) - Deploy to Knative - ---- - -## What's Next? - -After completing the getting started tutorials: - -- [Next steps](next-steps.md) - Continue your Knative journey -- [Traffic splitting](first-traffic-split.md) - Implement canary deployments -- [Code samples](../samples/) - Explore real-world examples -- [Complete tutorial](tutorial.md) - End-to-end application walkthrough - ---- - -## Components Overview - -**Knative Serving** - Deploy HTTP applications with automatic scaling and traffic management - -**Knative Eventing** - Build event-driven applications using CloudEvents - -**Knative Functions** - Create functions without managing containers or Kubernetes - ---- - -## Need Help? - -- **Slack:** [#knative-users](https://cloud-native.slack.com/) on CNCF Slack -- **Issues:** [Report problems](https://github.com/knative/docs/issues) -- **Community:** [Join working groups](../community/) - ---- - -## Installation for Production - -For production deployments, see: -- [YAML installation](../install/yaml-install/) - Direct kubectl installation -- [Operator installation](../install/operator/) - Automated lifecycle management -- [Platform-specific guides](../install/) - Cloud provider installations - -**Requirements:** Kubernetes 1.28+, cluster admin access \ No newline at end of file diff --git a/docs/versioned/getting-started/tutorial.md b/docs/versioned/getting-started/tutorial.md index d27d0ee78c..b761bbabea 100644 --- a/docs/versioned/getting-started/tutorial.md +++ b/docs/versioned/getting-started/tutorial.md @@ -9,15 +9,59 @@ function: tutorial # Welcome to the Knative Tutorials -### **Quick Start Tutorial** -Quickstart tutorial provides a simplified local installation to explore Knative Serving and Eventing features. +Choose your learning path based on your goals and experience level. -[Get Started :octicons-arrow-right-24:](../getting-started/README.md){ .md-button } +--- + +## Getting Started with Knative + +**Perfect for:** First-time users, developers evaluating Knative, and those wanting hands-on experience + +Comprehensive guide with multiple learning paths: +- Quick local installation (10 minutes with kind/minikube) +- Step-by-step tutorials for Serving, Eventing, and Functions +- Guidance for evaluators and decision makers +- Links to production installation options + +**What you'll learn:** Deploy your first service, explore autoscaling, build event-driven applications, and create serverless functions. + +[Explore Getting Started Paths :octicons-arrow-right-24:](../getting-started/README.md){ .md-button } + +--- + +## Knative Bookstore: End-to-End Sample Application + +**Perfect for:** Learning Knative through a real-world application -### **New: Knative's End-to-End Sample Application Tutorial** -Good starting point to learn Knative from scratch. Build an online bookstore application with Knative's powerful features. +Build a complete online bookstore application from scratch and explore Knative's powerful features in action. + +**What you'll learn:** Integration of Serving and Eventing, real-world architecture patterns, and best practices for production applications. + +[Start Bookstore Tutorial :octicons-arrow-right-24:](../bookstore/page-0/welcome-knative-bookstore-tutorial.md){ .md-button } + +![Knative Bookstore Application](../bookstore/page-0/images/1.png) + +--- + +## Quick Links + +Not sure where to start? Here are common paths: + +- **Want to try Knative in 10 minutes?** → [Quick Start Tutorial](../getting-started/README.md#i-want-to-try-knative-quickly) +- **Need to understand Knative first?** → [Getting Started for Evaluators](../getting-started/README.md#i-want-to-understand-knative-first) +- **Building event-driven apps?** → [Eventing Tutorial](../getting-started/README.md#i-want-to-explore-event-driven-features) +- **Creating serverless functions?** → [Functions Tutorial](../getting-started/README.md#i-want-to-build-serverless-functions) +- **Ready for production?** → [Installation Guide](../install/README.md) + +--- -[Get Started :octicons-arrow-right-24:](../bookstore/page-0/welcome-knative-bookstore-tutorial.md){ .md-button } +## Prerequisites +**For Quick Start Tutorial:** +- Docker +- kubectl +- 3 CPUs, 3 GB RAM -![image1](../bookstore/page-0/images/1.png) +**For Bookstore Tutorial:** +- Kubernetes cluster (local or cloud) +- Basic familiarity with Kubernetes concepts \ No newline at end of file From 796ecac4dd535fc244b0c6f46ff57f45993567eb Mon Sep 17 00:00:00 2001 From: codeEvolveZenith345 Date: Fri, 14 Nov 2025 08:53:13 +0000 Subject: [PATCH 3/4] fix:heading sizes Signed-off-by: codeEvolveZenith345 --- docs/versioned/getting-started/tutorial.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/docs/versioned/getting-started/tutorial.md b/docs/versioned/getting-started/tutorial.md index b761bbabea..472be736cc 100644 --- a/docs/versioned/getting-started/tutorial.md +++ b/docs/versioned/getting-started/tutorial.md @@ -13,7 +13,7 @@ Choose your learning path based on your goals and experience level. --- -## Getting Started with Knative +### Getting Started with Knative **Perfect for:** First-time users, developers evaluating Knative, and those wanting hands-on experience @@ -29,7 +29,7 @@ Comprehensive guide with multiple learning paths: --- -## Knative Bookstore: End-to-End Sample Application +### Knative Bookstore: End-to-End Sample Application **Perfect for:** Learning Knative through a real-world application @@ -43,7 +43,7 @@ Build a complete online bookstore application from scratch and explore Knative's --- -## Quick Links +### Quick Links Not sure where to start? Here are common paths: @@ -55,7 +55,7 @@ Not sure where to start? Here are common paths: --- -## Prerequisites +### Prerequisites **For Quick Start Tutorial:** - Docker @@ -64,4 +64,4 @@ Not sure where to start? Here are common paths: **For Bookstore Tutorial:** - Kubernetes cluster (local or cloud) -- Basic familiarity with Kubernetes concepts \ No newline at end of file +- Basic familiarity with Kubernetes concepts From ebcc25df9a98a2402772cada5fa4769fec387714 Mon Sep 17 00:00:00 2001 From: codeEvolveZenith345 Date: Sat, 15 Nov 2025 04:11:53 +0000 Subject: [PATCH 4/4] fix: tutorial list rendering and update links to technical overview Signed-off-by: codeEvolveZenith345 --- docs/versioned/getting-started/tutorial.md | 42 +++++++++++----------- 1 file changed, 22 insertions(+), 20 deletions(-) diff --git a/docs/versioned/getting-started/tutorial.md b/docs/versioned/getting-started/tutorial.md index 472be736cc..6186d9653d 100644 --- a/docs/versioned/getting-started/tutorial.md +++ b/docs/versioned/getting-started/tutorial.md @@ -13,15 +13,14 @@ Choose your learning path based on your goals and experience level. --- -### Getting Started with Knative +## Getting Started with Knative -**Perfect for:** First-time users, developers evaluating Knative, and those wanting hands-on experience +**Perfect for:** First-time users and developers wanting hands-on experience Comprehensive guide with multiple learning paths: -- Quick local installation (10 minutes with kind/minikube) -- Step-by-step tutorials for Serving, Eventing, and Functions -- Guidance for evaluators and decision makers -- Links to production installation options + + - Quick local installation (10 minutes with kind/minikube) + - Step-by-step tutorials for Serving, Eventing, and Functions **What you'll learn:** Deploy your first service, explore autoscaling, build event-driven applications, and create serverless functions. @@ -29,7 +28,7 @@ Comprehensive guide with multiple learning paths: --- -### Knative Bookstore: End-to-End Sample Application +## Knative Bookstore: End-to-End Sample Application **Perfect for:** Learning Knative through a real-world application @@ -43,25 +42,28 @@ Build a complete online bookstore application from scratch and explore Knative's --- -### Quick Links +## Not sure where to start? -Not sure where to start? Here are common paths: +Here are common paths: -- **Want to try Knative in 10 minutes?** → [Quick Start Tutorial](../getting-started/README.md#i-want-to-try-knative-quickly) -- **Need to understand Knative first?** → [Getting Started for Evaluators](../getting-started/README.md#i-want-to-understand-knative-first) -- **Building event-driven apps?** → [Eventing Tutorial](../getting-started/README.md#i-want-to-explore-event-driven-features) -- **Creating serverless functions?** → [Functions Tutorial](../getting-started/README.md#i-want-to-build-serverless-functions) -- **Ready for production?** → [Installation Guide](../install/README.md) + - **Want to try Knative in 10 minutes?** → [Quick Start Tutorial](../getting-started/README.md#i-want-to-try-knative-quickly) + - **Need to understand Knative first?** → [Technical Overview](../README.md) + - **Building event-driven apps?** → [Eventing Tutorial](../getting-started/README.md#i-want-to-explore-event-driven-features) + - **Creating serverless functions?** → [Functions Tutorial](../getting-started/README.md#i-want-to-build-serverless-functions) + - **Ready for production?** → [Installation Guide](../install/README.md) --- -### Prerequisites +## Prerequisites **For Quick Start Tutorial:** -- Docker -- kubectl -- 3 CPUs, 3 GB RAM + + - Docker + - kubectl + - 3 CPUs, 3 GB RAM **For Bookstore Tutorial:** -- Kubernetes cluster (local or cloud) -- Basic familiarity with Kubernetes concepts + + - Kubernetes cluster (local or cloud) + - Basic familiarity with Kubernetes concepts + \ No newline at end of file