docs: add packages to readme and add new logo

README.md

@@ -9,11 +9,23 @@
 This is the repository of "KubeOps" - The dotnet Kubernetes Operator SDK.
 
 The documentation is provided in the code itself (description of the methods and classes)
-and each package contains a README.md with further information/documentation.
+and each package contains a README with further information/documentation.
+
+Also, there is a `docfx` site that provides further documentation and examples.
+You can find it [here](https://buehler.github.io/dotnet-operator-sdk/).
 
 ## Packages
 
-TODO.
+The following packages exist:
+
+| Package                                                      | Description                                         | Version                                                                                                               | Pre Version                                                                                                                                                     |
+|--------------------------------------------------------------|-----------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------|
+| [KubeOps.Abstractions](./src/KubeOps.Abstractions/README.md) | Contains abstractions, attributes, etc. for the SDK | [![Nuget](https://img.shields.io/nuget/v/KubeOps.Abstractions)](https://www.nuget.org/packages/KubeOps.Abstractions/) | [![Nuget](https://img.shields.io/nuget/vpre/KubeOps.Abstractions?label=nuget%20prerelease)](https://www.nuget.org/packages/KubeOps.Abstractions/absoluteLatest) |
+| [KubeOps.Cli](./src/KubeOps.Cli/README.md)                   | CLI Dotnet Tool to generate stuff                   | [![Nuget](https://img.shields.io/nuget/v/KubeOps.Cli)](https://www.nuget.org/packages/KubeOps.Cli/)                   | [![Nuget](https://img.shields.io/nuget/vpre/KubeOps.Cli?label=nuget%20prerelease)](https://www.nuget.org/packages/KubeOps.Cli/absoluteLatest)                   |
+| [KubeOps.Generator](./src/KubeOps.Generator/README.md)       | Source Generator for the SDK                        | [![Nuget](https://img.shields.io/nuget/v/KubeOps.Generator)](https://www.nuget.org/packages/KubeOps.Generator/)       | [![Nuget](https://img.shields.io/nuget/vpre/KubeOps.Generator?label=nuget%20prerelease)](https://www.nuget.org/packages/KubeOps.Generator/absoluteLatest)       |
+| [KubeOps.Operator](./src/KubeOps.Operator/README.md)         | Main SDK entrypoint to create an operator           | [![Nuget](https://img.shields.io/nuget/v/KubeOps.Operator)](https://www.nuget.org/packages/KubeOps.Operator/)         | [![Nuget](https://img.shields.io/nuget/vpre/KubeOps.Operator?label=nuget%20prerelease)](https://www.nuget.org/packages/KubeOps.Operator/absoluteLatest)         |
+| [KubeOps.Operator.Web](./src/KubeOps.Operator.Web/README.md) | Web part of the operator (for webhooks)             | [![Nuget](https://img.shields.io/nuget/v/KubeOps.Operator.Web)](https://www.nuget.org/packages/KubeOps.Operator.Web/) | [![Nuget](https://img.shields.io/nuget/vpre/KubeOps.Operator.Web?label=nuget%20prerelease)](https://www.nuget.org/packages/KubeOps.Operator.Web/absoluteLatest) |
+| [KubeOps.Transpiler](./src/KubeOps.Transpiler/README.md)     | Transpilation helpers for CRDs and RBAC elements    | [![Nuget](https://img.shields.io/nuget/v/KubeOps.Transpiler)](https://www.nuget.org/packages/KubeOps.Transpiler/)     | [![Nuget](https://img.shields.io/nuget/vpre/KubeOps.Transpiler?label=nuget%20prerelease)](https://www.nuget.org/packages/KubeOps.Transpiler/absoluteLatest)     |
 
 ## Contribution
 
@@ -22,6 +34,7 @@ Read more about contribution (especially for setting up your local environment)
 in the [CONTRIBUTING file](./CONTRIBUTING.md).
 
 In short:
+
 - Check out the code
 - Develop on KubeOps
 - Use some Kubernetes to run the test operator against

docfx.json

@@ -17,7 +17,10 @@
       }
     ],
     "output": "_site",
-    "globalMetadataFiles": [],
+    "globalMetadata": {
+      "_appLogoPath": "./res/logo.png",
+      "_appFaviconPath": "./res/logo.png"
+    },
     "fileMetadataFiles": [],
     "template": ["default", "modern"],
     "postProcessors": [],

toc.yml

@@ -14,5 +14,7 @@
       href: src/KubeOps.Operator/README.md
     - name: KubeOps Operator Web
       href: src/KubeOps.Operator.Web/README.md
+    - name: KubeOps Transpiler
+      href: src/KubeOps.Transpiler/README.md
 - name: API Reference
   href: docs/api/