diff --git a/.github/workflows/gh-pages.yml b/.github/workflows/gh-pages.yml new file mode 100644 index 00000000..2af5e087 --- /dev/null +++ b/.github/workflows/gh-pages.yml @@ -0,0 +1,68 @@ +name: Deploy GitHub Pages + +on: + push: + branches: + - master + + workflow_dispatch: + +permissions: + contents: read + pages: write + id-token: write + +concurrency: + group: pages + cancel-in-progress: true + +jobs: + build: + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v3 + with: + fetch-depth: 1 + + - run: mkdir public + + - name: Build Index + uses: jaywcjlove/markdown-to-html-cli@main + with: + source: res/docs_index.md + output: public/index.html + github-corners: https://github.com/buehler/dotnet-operator-sdk + + - name: Build KubeOps + uses: jaywcjlove/markdown-to-html-cli@main + with: + source: src/KubeOps/README.md + output: public/kubeops.html + github-corners: https://github.com/buehler/dotnet-operator-sdk/tree/master/src/KubeOps + + - name: Build KubeOps.KubernetesClient + uses: jaywcjlove/markdown-to-html-cli@main + with: + source: src/KubeOps.KubernetesClient/README.md + output: public/kubeops-kubernetesclient.html + github-corners: https://github.com/buehler/dotnet-operator-sdk/tree/master/src/KubeOps.KubernetesClient + + - name: Build KubeOps.Templates + uses: jaywcjlove/markdown-to-html-cli@main + with: + source: src/KubeOps.Templates/README.md + output: public/kubeops-templates.html + github-corners: https://github.com/buehler/dotnet-operator-sdk/tree/master/src/KubeOps.Templates + + - name: Build KubeOps.Testing + uses: jaywcjlove/markdown-to-html-cli@main + with: + source: src/KubeOps.Testing/README.md + output: public/kubeops-testing.html + github-corners: https://github.com/buehler/dotnet-operator-sdk/tree/master/src/KubeOps.Testing + + - uses: actions/upload-pages-artifact@v1 + with: + path: public + + - uses: actions/deploy-pages@v1 diff --git a/res/docs_index.md b/res/docs_index.md new file mode 100644 index 00000000..8d20682e --- /dev/null +++ b/res/docs_index.md @@ -0,0 +1,30 @@ +# KubeOps + +![Code Security Testing](https://github.com/buehler/dotnet-operator-sdk/workflows/Code%20Security%20Testing/badge.svg) +![.NET Release](https://github.com/buehler/dotnet-operator-sdk/workflows/.NET%20Release/badge.svg) +![.NET Testing](https://github.com/buehler/dotnet-operator-sdk/workflows/.NET%20Testing/badge.svg) +[![Nuget](https://img.shields.io/nuget/v/KubeOps)](https://www.nuget.org/packages/KubeOps/) +[![Nuget](https://img.shields.io/nuget/vpre/KubeOps?label=nuget%20prerelease)](https://www.nuget.org/packages/KubeOps/absoluteLatest) + +This is the repository of "KubeOps" - The dotnet Kubernetes Operator SDK. + +The documentation moved to respective `README` files in the packages. +Please consult them via nuget explorer, on the GitHub repository, or on the links +below. + +## Packages + +- [KubeOps](./kubeops.html) - The core package of the SDK. +- [KubeOps.KubernetesClient](./kubeops-kubernetesclient.html) - An improved Kubernetes client to interact with Kubernetes APIs. +- [KubeOps.Templates](./kubeops-templates.html) - `dotnet new` templates for creating operators. +- [KubeOps.Testing](./kubeops-testing.html) - Extensions that support integration testing. + +## Contribution + +If you want to contribute, feel free to open a pull request or write issues :-) + +## Motivation + +The motivation was to learn more about the quirks of kubernetes itself and +provide an alternative to kubebuilder and operator sdk which are both +written in GoLang.