Merge pull request #717 from a-hilaly/docs-versioning

docs: add versioned documentation site for v0.1.0 through v0.4.1

Author: k8s-ci-robot

website/README.md

@@ -45,3 +45,21 @@ $ GIT_USER=<Your GitHub username> yarn deploy
 ```
 
 If you are using GitHub pages for hosting, this command is a convenient way to build the website and push to the `gh-pages` branch.
+
+### Versioning
+
+When a new kro controller version is released, you should also update/release the documentation:
+
+1. **Update `version.json`**  
+    Add the new version to the `version.json` file.
+
+2. **Create a Docusaurus version**  
+    Remove the `v` prefix from your version (e.g., `v0.1.0` → `0.1.0`):
+
+    ```shell
+    version_number=${version#v}
+    npm run docusaurus docs:version $version_number
+    ```
+
+3. **Submit a Pull Request**  
+    Commit your changes and open a PR to publish the new versioned docs.

website/docs/docs/overview.md.bak

@@ -0,0 +1,116 @@
+---
+sidebar_position: 1
+---
+
+# What is kro?
+
+**kro** (Kube Resource Orchestrator) is an open-source, Kubernetes-native project
+that allows you to define custom **Kubernetes APIs** using simple and straightforward
+configuration. With kro, you can easily configure new custom APIs that create a
+group of Kubernetes objects and the logical operations between them. kro leverages
+[CEL (Common Expression Language)](https://github.com/google/cel-spec), the same
+language used by Kubernetes webhooks, for logical operations. Using CEL expressions,
+you can easily pass values from one object to another and incorporate conditionals into
+your custom API definitions. Based on the CEL expressions, kro automatically calculates
+the order in which objects should be created. You can define default values for fields
+in the API specification, streamlining the process for end users who can then
+effortlessly invoke these custom APIs to create grouped resources.
+
+# How does kro work?
+
+### Developer interface
+
+When the end user applies a YAML spec to the cluster using the **Custom API**,
+the API creates a set of resources within the cluster. These resources can
+include both **native Kubernetes** resources and any **Custom Resource
+Definitions (CRDs)** installed in the cluster. Some of these resources may
+create additional resources outside of your cluster.
+
+As depicted in the following diagram, the Developers call the Custom API, which
+creates resources such as the **Deployment**, **Ingress**, **ServiceAccount**,
+**Prometheus Monitor**, **IAM Role**, **IAM Policy**, and **Amazon S3 Bucket**.
+This allows the Developers to easily manage and deploy their applications in a
+standardized and streamlined manner.
+
+<div align="center">
+
+![End user interface - Custom API](../../../images/architecture-diagrams/KRO-Dev-Interface.png)
+_Figure 1: End user interface - Custom API_
+
+</div>
+
+### ResourceGraphDefinition
+
+When you install **Kro** in your cluster, it installs a Custom Resource
+Definition (CRD) called **ResourceGraphDefinition (RG)**. The **Platform**, **Security**,
+and **Compliance** teams can collaborate to create custom APIs by defining
+Custom Resources for the ResourceGraphDefinition CRD.
+
+In the depicted example, the **Platform Team** has created a **RG** with
+arbitrary name "Application Stack" that encapsulates the necessary resources,
+along with any additional logic, abstractions, and security best practices. When
+the RGD is applied to the cluster, a new API of kind ApplicationStack is created
+and available for the Developer to interact with. The Developers no longer need to
+directly manage the underlying infrastructure complexities, as the custom API
+handles the deployment and configuration of the required resources.
+
+<div align="center">
+
+![Platform Team Interface](../../../images/architecture-diagrams/KRO-Platform-Team.png)
+_Figure 2: ResourceGraphDefinition (RG) - Platform Team Interface_
+
+</div>
+
+### ResourceGraphDefinition Instance
+
+Developer teams can create multiple instances of the **Application Stack**, each
+tailored to their specific requirements. As shown, **Dev Team A** and **Dev Team
+B** have both instantiated their own Application Stacks. While the underlying
+resources are similar, **Dev Team A** has chosen to expose their service
+externally, leveraging the Ingress option, while **Dev Team B** has opted to
+keep their service internal to the cluster. This flexibility allows each
+development team to customize their application stack based on their specific
+requirements.
+
+<div align="center">
+
+![ResourceGraphDefinition Instance](../../../images/architecture-diagrams/KRO-Instance.png)
+_Figure 3: ResourceGraphDefinition Instance (RGI)_
+
+</div>
+
+# Why kro?
+
+### Manage any group of resources as one unit
+
+Using **kro**, the **Platform Team** can enable Developer teams to quickly
+deploy and manage applications and their dependencies as one unit, handling the
+entire lifecycle from deployment to maintenance. The new APIs integrate
+seamlessly with developers' existing CD tools, preserving familiar processes and
+interfaces to simplify adoption.
+
+### Collaborate
+
+Transform **Kubernetes** into your unified platform configuration framework
+using **kro**. Platform, Compliance, and Security teams work together to develop
+APIs that standardize and streamline configurations, making it easier for
+Developer teams to adopt secure, compliant practices. This collaboration lets
+you build your organizational standards directly into the APIs, ensuring every
+application deployment aligns with security and compliance requirements without
+adding complexity for developers.
+
+### Standardize
+
+By creating unified APIs, you can define and enforce best practices across all
+environments, ensuring every application meets organizational requirements and
+achieving consistency across deployment environments.
+
+# Community
+
+We welcome questions, suggestions, and contributions from the community! To get
+involved, check out our
+[contributing guide](https://github.com/kro-run/kro/blob/main/CONTRIBUTING.md).
+For bugs or feature requests, feel free to
+[submit an issue](https://github.com/kro-run/kro/issues). You’re also invited to
+join our
+[community](https://github.com/kro-run/kro?tab=readme-ov-file#community-participation).

website/docusaurus.config.ts

@@ -24,9 +24,9 @@ const config: Config = {
 
   onBrokenLinks: "throw",
   markdown: {
-      hooks: {
-        onBrokenMarkdownLinks: "warn",
-      },
+    hooks: {
+      onBrokenMarkdownLinks: "warn",
+    },
   },
 
   // Even if you don't use internationalization, you can use this field to set
@@ -71,6 +71,9 @@ const config: Config = {
           // Please change this to your repo.
           // Remove this to remove the "edit this page" links.
           editUrl: "https://github.com/kubernetes-sigs/kro/tree/main/website",
+          disableVersioning: false,
+          includeCurrentVersion: true,
+          lastVersion: "0.4.1",
         },
         blog: false,
         theme: {
@@ -182,7 +185,8 @@ const config: Config = {
           ],
         },
       ],
-      copyright: "kro is a subproject of Kubernetes SIG Cloud Provider. Kubernetes is a CNCF graduated project."
+      copyright:
+        "kro is a subproject of Kubernetes SIG Cloud Provider. Kubernetes is a CNCF graduated project.",
     },
     /* announcementBar: {
       id: `beta announcement`,

website/src/components/HomepageFeatures/index.tsx

@@ -18,7 +18,7 @@ const FeatureList: FeatureItem[] = [
     id: "benzene-ring-svgrepo-com",
     fill: "white",
     scale: 0.7,
-    Svg: require("@site/static/img/resources.svg").default,
+    Svg: require("/img/resources.svg").default,
     description: (
       <>
         Create powerful abstractions that encapsulate complex Kubernetes
@@ -29,7 +29,7 @@ const FeatureList: FeatureItem[] = [
   },
   {
     title: "Effortless Orchestration",
-    Svg: require("@site/static/img/qrcode.svg").default,
+    Svg: require("/img/qrcode.svg").default,
     id: "qr-code-svgrepo-com",
     fill: "a2",
     scale: 0.6,
@@ -46,7 +46,7 @@ const FeatureList: FeatureItem[] = [
     scale: 0.6,
     id: "scale-svgrepo-com",
     fill: "white",
-    Svg: require("@site/static/img/expand-arrows.svg").default,
+    Svg: require("/img/expand-arrows.svg").default,
     description: (
       <>
         kro effortlessly scales your resource management from simple deployments

website/src/pages/index.module.css

@@ -8,7 +8,7 @@
   text-align: center;
   position: relative;
   overflow: hidden;
-  background-image: url('@site/static/img/bg-large.png');
+  background-image: url("/img/bg-large.png");
   height: 420px;
   opacity: 0.1;
 }
@@ -76,26 +76,26 @@
   text-decoration: none;
 }
 
-[data-theme='dark'] .indexCtas a {
+[data-theme="dark"] .indexCtas a {
   background-color: var(--main-color-dark);
   border-color: var(--main-color-dark);
 }
 
-[data-theme='dark'] .indexCtas a:hover {
+[data-theme="dark"] .indexCtas a:hover {
   background-color: #fb8422;
   border-color: #fb8422;
   text-decoration: none;
 }
 
-[data-theme='dark'] .heroA {
+[data-theme="dark"] .heroA {
   background-image: linear-gradient(rgb(54, 54, 54), rgb(27, 27, 29));
 }
 
-[data-theme='dark'] .heroProjectTagline {
+[data-theme="dark"] .heroProjectTagline {
   color: #fff;
 }
 
-[data-theme='dark'] .heroProjectTaglineSubtitle {
+[data-theme="dark"] .heroProjectTaglineSubtitle {
   color: #fff;
 }
 
@@ -151,4 +151,4 @@
   .indexCtasGitHubButton {
     display: none;
   }
-}
+}