Skip to content

Commit b766adb

Browse files
author
Christoph Bühler
committed
docs: add packages to readme and add new logo
1 parent 643f3c0 commit b766adb

File tree

5 files changed

+21
-3
lines changed

5 files changed

+21
-3
lines changed

README.md

Lines changed: 15 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,11 +9,23 @@
99
This is the repository of "KubeOps" - The dotnet Kubernetes Operator SDK.
1010

1111
The documentation is provided in the code itself (description of the methods and classes)
12-
and each package contains a README.md with further information/documentation.
12+
and each package contains a README with further information/documentation.
13+
14+
Also, there is a `docfx` site that provides further documentation and examples.
15+
You can find it [here](https://buehler.github.io/dotnet-operator-sdk/).
1316

1417
## Packages
1518

16-
TODO.
19+
The following packages exist:
20+
21+
| Package | Description | Version | Pre Version |
22+
|--------------------------------------------------------------|-----------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------|
23+
| [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) |
24+
| [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) |
25+
| [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) |
26+
| [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) |
27+
| [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) |
28+
| [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) |
1729

1830
## Contribution
1931

@@ -22,6 +34,7 @@ Read more about contribution (especially for setting up your local environment)
2234
in the [CONTRIBUTING file](./CONTRIBUTING.md).
2335

2436
In short:
37+
2538
- Check out the code
2639
- Develop on KubeOps
2740
- Use some Kubernetes to run the test operator against

docfx.json

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,10 @@
1717
}
1818
],
1919
"output": "_site",
20-
"globalMetadataFiles": [],
20+
"globalMetadata": {
21+
"_appLogoPath": "./res/logo.png",
22+
"_appFaviconPath": "./res/logo.png"
23+
},
2124
"fileMetadataFiles": [],
2225
"template": ["default", "modern"],
2326
"postProcessors": [],

res/icon.png

-343 KB
Loading

res/logo.png

3.93 KB
Loading

toc.yml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,5 +14,7 @@
1414
href: src/KubeOps.Operator/README.md
1515
- name: KubeOps Operator Web
1616
href: src/KubeOps.Operator.Web/README.md
17+
- name: KubeOps Transpiler
18+
href: src/KubeOps.Transpiler/README.md
1719
- name: API Reference
1820
href: docs/api/

0 commit comments

Comments
 (0)