wip

csviri · csviri · commit f9cdffd45577 · 2025-03-19T13:26:53.000+01:00
Signed-off-by: Attila Mészáros &lt;a_meszaros@apple.com&gt;
diff --git a/docs/content/en/blog/_index.md b/docs/content/en/blog/_index.md
@@ -1,6 +1,6 @@
 ---
 title: Blog
-menu: {main: {weight: 30}}
+menu: {main: {weight: 2}}
 ---
 
 This is the **blog** section. It has two categories: News and Releases.
diff --git a/docs/content/en/community/_index.md b/docs/content/en/community/_index.md
@@ -1,6 +1,6 @@
 ---
 title: Community
-menu: {main: {weight: 40}}
+menu: {main: {weight: 3}}
 ---
 
 <!--add blocks of content here to add more sections to the community page -->
diff --git a/docs/content/en/docs/_index.md b/docs/content/en/docs/_index.md
@@ -1,8 +1,8 @@
 ---
 title: Documentation
 linkTitle: Docs
-menu: {main: {weight: 20}}
-weight: 20
+menu: {main: {weight: 1}}
+weight: 1
 ---
 
 
diff --git a/docs/content/en/docs/documentation/_index.md b/docs/content/en/docs/documentation/_index.md
@@ -0,0 +1,4 @@
+---
+title: Documentation
+weight: 40
+---
diff --git a/docs/content/en/docs/documentation/architecture.md b/docs/content/en/docs/documentation/architecture.md
@@ -1,9 +1,8 @@
 ---
 title: Architecture and Internals
-weight: 90
+weight: 59
 ---
 
-
 This document gives an overview of the internal structure and components of Java Operator SDK core,
 in order to make it easier for developers to understand and contribute to it. This document is
 not intended to be a comprehensive reference, rather an introduction to the core concepts and we
diff --git a/docs/content/en/docs/documentation/configuration.md b/docs/content/en/docs/documentation/configuration.md
@@ -1,11 +1,8 @@
 ---
-title: Configuring JOSDK 
-layout: docs
-permalink: /docs/configuration
+title: Configurations
+weight: 56
 ---
 
-# Configuration options
-
 The Java Operator SDK (JOSDK) provides several abstractions that work great out of the 
 box. However, while we strive to cover the most common cases with the default behavior, we also 
 recognize that that default behavior is not always what any given user might want for their 
diff --git a/docs/content/en/docs/documentation/dependent-resources.md b/docs/content/en/docs/documentation/dependent-resources.md
@@ -1,6 +1,6 @@
 ---
 title: Dependent Resources
-weight: 60
+weight: 51
 ---
 
 ## Motivations and Goals
diff --git a/docs/content/en/docs/documentation/features.md b/docs/content/en/docs/documentation/features.md
@@ -1,10 +1,8 @@
 ---
 title: Features
-weight: 50
+weight: 41
 ---
 
-# Features
-
 The Java Operator SDK (JOSDK) is a high level framework and related tooling aimed at
 facilitating the implementation of Kubernetes operators. The features are by default following
 the best practices in an opinionated way. However, feature flags and other configuration options
diff --git a/docs/content/en/docs/documentation/workflows.md b/docs/content/en/docs/documentation/workflows.md
@@ -1,6 +1,6 @@
 ---
 title: Workflows
-weight: 70
+weight: 52
 ---
 
 ## Overview
diff --git a/docs/content/en/docs/getting-started/_index.md b/docs/content/en/docs/getting-started/_index.md
@@ -1,3 +1,4 @@
 ---
 title: Getting started
+weight: 5
 ---
diff --git a/docs/content/en/docs/getting-started/bootstrap-and-samples.md b/docs/content/en/docs/getting-started/bootstrap-and-samples.md
@@ -1,6 +1,6 @@
 ---
 title: Bootstrapping and samples
-weight: 30
+weight: 12
 ---
 
 ## Generating Project Skeleton
@@ -11,30 +11,28 @@ Project includes a maven plugin to generate a skeleton project:
 mvn io.javaoperatorsdk:bootstrapper:[version]:create -DprojectGroupId=org.acme -DprojectArtifactId=getting-started
 ```
 
+You can build this project with maven,
+the build will generate also the [CustomResourceDefinition](https://kubernetes.io/docs/concepts/extend-kubernetes/api-extension/custom-resources/#customresourcedefinitions) 
+for you.
+
 ## Getting started with samples
 
-The easiest way to get started with SDK is to start
-[minikube](https://kubernetes.io/docs/tasks/tools/install-minikube/) and
-execute one of our [examples](https://github.com/java-operator-sdk/java-operator-sdk/tree/main/sample-operators).
-There is a dedicated page to describe how to [use the samples](/docs/using-samples).
-
-Here are the main steps to develop the code and deploy the operator to a Kubernetes cluster.
-A more detailed and specific version can be found under `samples/mysql-schema/README.md`.
-
-
-- Setup `kubectl` to work with your Kubernetes cluster of choice. 
-- Apply Custom Resource Definition
-- Compile the whole project (framework + samples) using `mvn install` in the root directory
-- Run the main class of the sample you picked and check out the sample's README to see what it
-   does. When run locally the framework will use your Kubernetes client configuration (in `~/.
-   kube/config`) to establish a connection to the cluster. This is why it was important to set
-   up `kubectl` up front.
-- You can work in this local development mode to play with the code.
-- Build the Docker image and push it to the registry
-- Apply RBAC configuration
-- Apply deployment configuration
-- Verify if the operator is up and running. Don't run it locally anymore to avoid conflicts in
-   processing events from the cluster's API server.
+You can find examples under [sample-operators](https://github.com/java-operator-sdk/java-operator-sdk/tree/master/sample-operators)
+directory which are intended to demonstrate the usage of different components in different scenarios, but mainly are more real world
+examples:
+
+* *webpage*: Simple example creating an NGINX webserver from a Custom Resource containing HTML code. We provide more 
+  flavors of implementation, both with the low level APIs and higher level abstractions.
+* *mysql-schema*: Operator managing schemas in a MySQL database. Shows how to manage non Kubernetes resources.
+* *tomcat*: Operator with two controllers, managing Tomcat instances and Webapps running in Tomcat. The intention
+  with this example to show how to manage multiple related custom resources and/or more controllers.
+
+The easiest way to run / try out is to run one of the samples on
+[minikube](https://kubernetes.io/docs/tasks/tools/install-minikube/) or [kind](https://kind.sigs.k8s.io/).
+After applying the generated CRD, you can simply run your main class. The controller will automatically
+start communicate with you local Kubernetes cluster and reconcile custom resource after you create one.
+
+See also detailed instructions under [`samples/mysql-schema/README.md`](https://github.com/operator-framework/java-operator-sdk/blob/main/sample-operators/mysql-schema/README.md).
 
 
 
diff --git a/docs/content/en/docs/getting-started/intro-to-operators.md b/docs/content/en/docs/getting-started/intro-to-operators.md
@@ -1,6 +1,6 @@
 ---
 title: Introduction to Kubernetes operators
-weight: 20
+weight: 11
 ---
 
 ## Introduction & Resources 
diff --git a/docs/content/en/docs/getting-started/patterns-best-practices.md b/docs/content/en/docs/getting-started/patterns-best-practices.md
@@ -1,9 +1,8 @@
 ---
-title: Patterns and Best Practices
-weight: 25
+title: Patterns and best practices
+weight: 13
 ---
 
-
 This document describes patterns and best practices, to build and run operators, and how to
 implement them in terms of the Java Operator SDK (JOSDK).
 
diff --git a/docs/content/en/docs/glossary/_index.md b/docs/content/en/docs/glossary/_index.md
@@ -1,6 +1,6 @@
 ---
 title: Glossary
-weight: 40
+weight: 70
 ---
 
 - **Primary Resource** - the resource that represents the desired state that the controller is
diff --git a/docs/content/en/docs/migration/_index.md b/docs/content/en/docs/migration/_index.md
@@ -1,4 +1,5 @@
 ---
 title: Migrations
+weight: 150
 ---
 
diff --git a/docs/content/en/docs/using-samples/_index.md b/docs/content/en/docs/using-samples/_index.md

-Original file line number
+Diff line change
@@ @@ -0,0 +1,4 @@ @@
 +---
 +title: Documentation
 +weight: 40
 +---