Skip to content

Commit f52f00c

Browse files
authored
docs: republish gh pages (#512)
1 parent 164ec24 commit f52f00c

File tree

2 files changed

+98
-0
lines changed

2 files changed

+98
-0
lines changed

.github/workflows/gh-pages.yml

Lines changed: 68 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,68 @@
1+
name: Deploy GitHub Pages
2+
3+
on:
4+
push:
5+
branches:
6+
- master
7+
8+
workflow_dispatch:
9+
10+
permissions:
11+
contents: read
12+
pages: write
13+
id-token: write
14+
15+
concurrency:
16+
group: pages
17+
cancel-in-progress: true
18+
19+
jobs:
20+
build:
21+
runs-on: ubuntu-latest
22+
steps:
23+
- uses: actions/checkout@v3
24+
with:
25+
fetch-depth: 1
26+
27+
- run: mkdir public
28+
29+
- name: Build Index
30+
uses: jaywcjlove/markdown-to-html-cli@main
31+
with:
32+
source: res/docs_index.md
33+
output: public/index.html
34+
github-corners: https://github.com/buehler/dotnet-operator-sdk
35+
36+
- name: Build KubeOps
37+
uses: jaywcjlove/markdown-to-html-cli@main
38+
with:
39+
source: src/KubeOps/README.md
40+
output: public/kubeops.html
41+
github-corners: https://github.com/buehler/dotnet-operator-sdk/tree/master/src/KubeOps
42+
43+
- name: Build KubeOps.KubernetesClient
44+
uses: jaywcjlove/markdown-to-html-cli@main
45+
with:
46+
source: src/KubeOps.KubernetesClient/README.md
47+
output: public/kubeops-kubernetesclient.html
48+
github-corners: https://github.com/buehler/dotnet-operator-sdk/tree/master/src/KubeOps.KubernetesClient
49+
50+
- name: Build KubeOps.Templates
51+
uses: jaywcjlove/markdown-to-html-cli@main
52+
with:
53+
source: src/KubeOps.Templates/README.md
54+
output: public/kubeops-templates.html
55+
github-corners: https://github.com/buehler/dotnet-operator-sdk/tree/master/src/KubeOps.Templates
56+
57+
- name: Build KubeOps.Testing
58+
uses: jaywcjlove/markdown-to-html-cli@main
59+
with:
60+
source: src/KubeOps.Testing/README.md
61+
output: public/kubeops-testing.html
62+
github-corners: https://github.com/buehler/dotnet-operator-sdk/tree/master/src/KubeOps.Testing
63+
64+
- uses: actions/upload-pages-artifact@v1
65+
with:
66+
path: public
67+
68+
- uses: actions/deploy-pages@v1

res/docs_index.md

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
# KubeOps
2+
3+
![Code Security Testing](https://github.com/buehler/dotnet-operator-sdk/workflows/Code%20Security%20Testing/badge.svg)
4+
![.NET Release](https://github.com/buehler/dotnet-operator-sdk/workflows/.NET%20Release/badge.svg)
5+
![.NET Testing](https://github.com/buehler/dotnet-operator-sdk/workflows/.NET%20Testing/badge.svg)
6+
[![Nuget](https://img.shields.io/nuget/v/KubeOps)](https://www.nuget.org/packages/KubeOps/)
7+
[![Nuget](https://img.shields.io/nuget/vpre/KubeOps?label=nuget%20prerelease)](https://www.nuget.org/packages/KubeOps/absoluteLatest)
8+
9+
This is the repository of "KubeOps" - The dotnet Kubernetes Operator SDK.
10+
11+
The documentation moved to respective `README` files in the packages.
12+
Please consult them via nuget explorer, on the GitHub repository, or on the links
13+
below.
14+
15+
## Packages
16+
17+
- [KubeOps](./kubeops.html) - The core package of the SDK.
18+
- [KubeOps.KubernetesClient](./kubeops-kubernetesclient.html) - An improved Kubernetes client to interact with Kubernetes APIs.
19+
- [KubeOps.Templates](./kubeops-templates.html) - `dotnet new` templates for creating operators.
20+
- [KubeOps.Testing](./kubeops-testing.html) - Extensions that support integration testing.
21+
22+
## Contribution
23+
24+
If you want to contribute, feel free to open a pull request or write issues :-)
25+
26+
## Motivation
27+
28+
The motivation was to learn more about the quirks of kubernetes itself and
29+
provide an alternative to kubebuilder and operator sdk which are both
30+
written in GoLang.

0 commit comments

Comments
 (0)