Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Standalone site #125

Merged
merged 12 commits into from
Oct 26, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
36 changes: 36 additions & 0 deletions .github/workflows/ci.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
name: CI

on:
pull_request:
workflow_dispatch:

permissions:
contents: read

jobs:
build:
name: Build
runs-on: ubuntu-latest

steps:
- name: Checkout code
uses: actions/checkout@3df4ab11eba7bda6032a0b82a6bb43b11571feac # v4.0.0
with:
submodules: 'recursive'

- name: Set up Hugo
uses: peaceiris/actions-hugo@16361eb4acea8698b220b76c0d4e84e1fd22c61d # v2.6.0
with:
hugo-version: '0.110.0'
extended: true

- name: Set up Node
uses: actions/setup-node@5e21ff4d9bc1a8cf6de233a3057d20ec6b3fb69d # v3.8.1
with:
node-version: 16

- name: Set up PostCSS
run: npm install --save-dev autoprefixer postcss-cli postcss

- name: Build
run: hugo
69 changes: 69 additions & 0 deletions .github/workflows/publish.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,69 @@
name: Publish

on:
push:
branches: [ main ]
workflow_dispatch:

permissions:
contents: read

jobs:
build:
name: Build
runs-on: ubuntu-latest

steps:
- name: Checkout code
uses: actions/checkout@3df4ab11eba7bda6032a0b82a6bb43b11571feac # v4.0.0
with:
submodules: 'recursive'

- name: Set up Pages
id: pages
uses: actions/configure-pages@f156874f8191504dae5b037505266ed5dda6c382 # v3.0.6

- name: Set up Hugo
uses: peaceiris/actions-hugo@16361eb4acea8698b220b76c0d4e84e1fd22c61d # v2.6.0
with:
hugo-version: '0.110.0'
extended: true

- name: Set up Node
uses: actions/setup-node@5e21ff4d9bc1a8cf6de233a3057d20ec6b3fb69d # v3.8.1
with:
node-version: 16

- name: Set up PostCSS
run: npm install --save-dev autoprefixer postcss-cli postcss

- name: Build
run: hugo --environment production --baseURL ${{ steps.pages.outputs.base_url }}/

- name: Upload artifact
uses: actions/upload-pages-artifact@a753861a5debcf57bf8b404356158c8e1e33150c # v2.0.0
with:
path: ./public/

deploy:
name: Deploy
runs-on: ubuntu-latest
needs: build

permissions:
contents: read
pages: write
id-token: write

concurrency:
group: "pages"
cancel-in-progress: false

environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}

steps:
- name: Deploy to GitHub Pages
id: deployment
uses: actions/deploy-pages@9dbe3824824f8a1377b8e298bafde1a50ede43e5 # v2.0.4
21 changes: 0 additions & 21 deletions .github/workflows/trigger-submodule-update.yml

This file was deleted.

11 changes: 11 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1 +1,12 @@
.DS_Store
.idea
.vscode
resources/
public/
tmp/
bin/
scripts/__pycache__/
node_modules/
*.swp
*~
.hugo_build.lock
5 changes: 1 addition & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,4 @@
# koperator-docs
Documentation for Koperator - the operator for managing Apache Kafka on Kubernetes

This repository contains the documentation for the [Koperator](https://github.com/banzaicloud/koperator).

- The _master_ branch contains the public documentation of Koperator, published at https://banzaicloud.com/docs/supertubes/kafka-operator/
- The _supertubes-rebranding_ branch contains the Koperator docs for Calisti. The different branches are needed because of the different release schedule of Koperator and Calisti, and the path/url differences between the public Koperator docs and Calisti. The Calisti docs is published at [https://docs.calisti.app/sdm/koperator/](https://docs.calisti.app/sdm/koperator/).
This repository contains the documentation for the [Koperator](https://github.com/banzaicloud/koperator), published at [https://banzaicloud.github.io/koperator-docs/](https://banzaicloud.github.io/koperator-docs/)
103 changes: 103 additions & 0 deletions assets/icons/logo.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
65 changes: 65 additions & 0 deletions assets/scss/_styles_project.scss
Original file line number Diff line number Diff line change
@@ -0,0 +1,65 @@
/*

Nothing defined here. The Hugo project that uses this theme can override Bootstrap by adding a file to:

assets/scss/_styles_project.scss

*/
@import "tocbot";

.warning-block {
border-left: 6px solid red;
background: #FFFFFF;
padding: 16px;
}

/*
h3[class*="type-"]::before {
background-color: $primary;
content: "type";
font-size: 14px;
line-height: 22px;
padding: 3px 6px;
text-transform: uppercase;
}
*/

.property-optional::after {
content: "optional";
background-color: $secondary;
font-size: 14px;
line-height: 22px;
padding: 3px 6px;
text-transform: uppercase;
}
.property-required::after {
content: "required";
background-color: $primary;
color: white;
font-size: 14px;
line-height: 22px;
padding: 3px 6px;
text-transform: uppercase;
}

.main-lead {
line-height: 1.5;
}

// Match fontsize of sections with code in their titles for CRD reference pages
.td-content > h4 > em {
font-size: 87.5%;
}

.td-content * a {
&[href*="//"]:not([href*="localhost"]):not([href*="bank-vaults.dev"]):not([href*="github.com/bank-vaults"]):after {
display: inline-block;
width: .6em;
height: .6em;
background-image: url(data:image/svg+xml;base64,PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHdpZHRoPSIyNCIgaGVpZ2h0PSIyNCIgdmlld0JveD0iMCAwIDI0IDI0Ij48cGF0aCBkPSJNMjEgMTN2MTBoLTIxdi0xOWgxMnYyaC0xMHYxNWgxN3YtOGgyem0zLTEyaC0xMC45ODhsNC4wMzUgNC02Ljk3NyA3LjA3IDIuODI4IDIuODI4IDYuOTc3LTcuMDcgNC4xMjUgNC4xNzJ2LTExeiIvPjwvc3ZnPg==);
content: " ";
margin-left: .2em;
margin-right: .2em;
background-size: cover;
}
}
2 changes: 2 additions & 0 deletions assets/scss/_variables_project.scss
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
$navbar-dark-color: white; // Set navbar text to white to increase contrast
$blue: #2263BF !default; // Override breadcrumb and sidebar text color to increase contrast
1 change: 1 addition & 0 deletions assets/scss/tocbot.css

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Loading