Skip to content

Commit

Permalink
initial content for new k8up site
Browse files Browse the repository at this point in the history
  • Loading branch information
tobru committed Apr 15, 2024
1 parent 0f9e3e7 commit f70a419
Show file tree
Hide file tree
Showing 24 changed files with 396 additions and 128 deletions.
36 changes: 36 additions & 0 deletions assets/scss/_variables.scss
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
// Define CSS variables
:root {
--condensed-font-family: "Oswald", "Impact", "Arial Black", sans-serif, -apple-system, BlinkMacSystemFont, Roboto,
Ubuntu;
--rounded-font-family: "Nunito", -apple-system, BlinkMacSystemFont, "Segoe UI", Helvetica, Arial, sans-serif, Roboto,
Ubuntu, "Apple Color Emoji", "Segoe UI Emoji", "Segoe UI Symbol";

--text-color: var(--black);
--black: #000000;
--white: #ffffff;
--link-color: var(--primary-600);
--menu-link-color: var(--black);
--menu-link-color-hover: var(--gray-800);
--footer-link-color: var(--white);
--footer-link-color-hover: var(--primary-400);
--gutter: 25px;
--container-width: 1200px;
--content-width: 895px;

--primary-400: #1A5CE6;
--primary-600: #a08794;
--primary-700: #1A5CE6;
--primary-800: #bb7e8c;

--gray-200: #eaecf0;
--gray-300: #e5e5e5;
--gray-400: #e4e4e4;
--gray-600: #b1b1b1;
--gray-700: #767676;
--gray-800: #5f6367;
}

// Define SCSS variables.
$desktop-width: calc(1200px + 25px + 25px);
$min-desktop: 1000px;
$mobile-max: 999px;
17 changes: 3 additions & 14 deletions config/_default/hugo.yaml
Original file line number Diff line number Diff line change
@@ -1,23 +1,12 @@
######################## default configuration ####################
# Your theme name
theme: "dot-org-hugo-theme"
# Title of your website (required).
title: "Dot Org Theme Demo"
# Default time zone for time stamps; use any valid tz database name: https://en.wikipedia.org/wiki/List_of_tz_database_time_zones#List
timeZone: "America/Los_Angeles"
title: "K8up - Kubernetes Backup Operator"
timeZone: "Europe/Zurich"

######################## i18n ####################
# Auto-detect Chinese/Japanese/Korean Languages in the content. see: https://gohugo.io/getting-started/configuration/#hascjklanguage
hasCJKLanguage: true
# Set default content directory for multilingual
hasCJKLanguage: false
contentDir: content/en/
# Set fallback if international version is not available
defaultContentLanguage: en
# Set the default language as the root rather than in folder i.e. don't use /en/
defaultContentLanguageInSubdir: false

######################## privacy & speed ####################
# Enable do not track, no cookies on Video embeds
privacy:
youtube:
privacyEnhanced: true
Expand Down
144 changes: 48 additions & 96 deletions config/_default/languages.yaml
Original file line number Diff line number Diff line change
@@ -1,105 +1,57 @@
en:
languageName: English
weight: 1
### copyright (markdown can be used) ###
copyright: "Copyright &copy; {{< current_year >}} Company Name. All Rights Reserved. [Dot Org Theme](https://github.com/cncf/dot-org-hugo-theme) for Hugo by [CNCF](https://www.cncf.io)."
title: "Site Title"
description: "Site Description"
copyright: "Copyright &copy; K8up Authors {{< current_year >}}. Documentation distributed under [CC-BY-4.0](https://creativecommons.org/licenses/by/4.0/) -- Copyright &copy; {{< current_year >}} The Linux Foundation. All rights reserved. The Linux Foundation has registered trademarks and uses trademarks. For a list of trademarks of The Linux Foundation, please see our [Trademark Usage](https://www.linuxfoundation.org/legal/trademark-usage) page. -- [Dot Org Theme](https://github.com/cncf/dot-org-hugo-theme) for Hugo by [CNCF](https://www.cncf.io)."
title: "K8up - Kubernetes Backup Operator"
description: "Kubernetes Backup Operator"
params:
### accessibility ###
accessibility:
skip_text: "Skip to content"
help_text: "Accessibility Statement"
help_url: "/example-page/"
### calls to action ###
main_cta:
text: "Join"
link: "/example-page/"
text: "Getting Started"
link: "https://k8up.io/k8up/2.8/tutorials/tutorial.html"
footer_cta:
text: "Join us"
link: "/example-page/"
text: "GitHub"
link: "https://github.com/k8up-io/"
github_edit: "Edit this page on GitHub"
### example menu showing children ###

menu:
main:
- identifier: "about"
name: "About"
url: "/example-page/"
weight: 1
- identifier: "child-1"
name: "Example Child Page"
url: "/example-page/"
weight: 1
post: "Lorem ipsum dolor sit amet consectetuer adipiscing elit aenean commodo."
parent: "about"
- identifier: "child-2"
name: "Example Child Page"
url: "/example-page/"
weight: 2
post: "Aenean commodo ligula get dolor. Aenean massa."
parent: "about"
- identifier: "child-3"
name: "Example Child Page"
url: "/example-page/"
weight: 3
post: "Nulla consequat massa quis enim. Donec pede justo."
parent: "about"
- identifier: "example"
name: "Example"
url: "/example-page/"
weight: 2
- identifier: "example-1"
name: "Example Child Page"
url: "/example-page/"
weight: 1
post: "Lorem ipsum dolor sit amet consectetuer adipiscing elit aenean commodo."
parent: "example"
- identifier: "example-2"
name: "Example Child Page"
url: "/example-page/"
weight: 2
post: "Nulla consequat massa quis enim. Donec pede justo."
parent: "example"
- identifier: "example-3"
name: "Example Child Page"
url: "/example-page/"
weight: 3
post: "Aenean commodo ligula get dolor. Aenean massa. "
parent: "example"
- identifier: "demo-page"
name: "Demo Page"
url: "/demo-page/"
weight: 3
- identifier: "faq"
name: "FAQs"
url: "/faq/"
weight: 4
- identifier: "blog"
name: "Blog"
url: "/blog/"
weight: 5
es:
languageName: Spanish
contentDir: content/es
weight: 2
title: "Título del Sitio"
description: "Descripción del Sitio"
menu:
main:
- identifier: "about"
name: "Acerca de"
url: "/example-page/"
weight: 1
- identifier: "child-1"
name: "Página Hija de Ejemplo"
url: "/example-page/"
weight: 1
parent: "about"
- identifier: "faq"
name: "FAQs"
url: "/faq/"
weight: 3
- identifier: "blog"
name: "Blog"
url: "/blog/"
weight: 2
- identifier: "docs"
name: "Documentation"
url: "https://docs.k8up.io/"
weight: 1
- identifier: "community"
name: "Community"
weight: 2
- identifier: "about"
name: "About"
url: "/community/"
weight: 1
parent: "community"
- identifier: "contrib"
name: "Contribution Guide"
url: "/contrib/"
weight: 2
parent: "community"
- identifier: "coc"
name: "Code of Conduct"
url: "/coc/"
weight: 3
parent: "community"
- identifier: "security"
name: "Vulnerability Reporting"
url: "/vulnerabilities/"
weight: 4
parent: "community"
- identifier: "visual"
name: "Visual Design"
url: "/visual/"
weight: 5
parent: "community"
- identifier: "github"
name: "GitHub"
url: "https://github.com/k8up-io/k8up"
weight: 3
- identifier: "roadmap"
name: "Roadmap"
url: "https://github.com/k8up-io/k8up/milestones"
weight: 4
18 changes: 9 additions & 9 deletions config/_default/params.yaml
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
######################## custom scripts & styles ####################

# Add custom assets relative to /static or via https
logo_on_white: "/img/logo-b.svg"
logo_on_black: "/img/logo-w.svg"
logo_on_white: "images/k8up-logo.svg"
logo_on_black: "images/k8up-logo-white-text.svg"
custom_js: []
custom_css: []

Expand All @@ -12,22 +12,22 @@ custom_css: []
images: ["/img/social-share.png"]

github:
repo_url: "https://github.com/username/repo/blob/master"
repo_url: "https://github.com/k8up-io/website"
show_edit_link: true

social_links:
devstats: ""
devstats: "https://k8up.devstats.cncf.io/"
discord: ""
facebook: ""
flickr: ""
github: "https://github.com/cncf/dot-org-hugo-theme"
github: "https://github.com/k8up-io/k8up"
instagram: ""
landscape: ""
linkedin: "https://www.linkedin.com/company/cloud-native-computing-foundation"
mastodon: ""
linkedin: ""
mastodon: "https://mastodon.vshn.social/@k8up"
pinterest: ""
rss: ""
slack: ""
slack: "https://app.slack.com/client/T08PSQ7BQ/C06GP0D5FEF"
stackoverflow: ""
threads: ""
twitter: ""
Expand All @@ -37,4 +37,4 @@ social_links:
# Makes the header sticky on tall screens
sticky_header: true
# Enable search in header UI
show_search: true
show_search: false
3 changes: 0 additions & 3 deletions config/development/hugo.yaml
Original file line number Diff line number Diff line change
@@ -1,4 +1 @@
######################## development configuration ####################
# The base URL of your site (required). This will be prepended to all relative URLs.
baseURL: http://localhost:1313/

4 changes: 1 addition & 3 deletions config/production/hugo.yaml
Original file line number Diff line number Diff line change
@@ -1,6 +1,4 @@
######################## production configuration ####################
# The base URL of your site (required). This will be prepended to all relative URLs.
baseURL:
baseURL: https://k8up.io/
googleAnalytics:
enableRobotsTXT: true
build:
Expand Down
77 changes: 77 additions & 0 deletions content/en/_index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,77 @@
---
title: K8up
description: Welcome to K8up - a Kubernetes Backup Operator
---

## Kubernetes Backup Operator

{{< intro >}}
K8up (pronounced /keɪtæpp/ or simply "ketchup") is a Kubernetes Operator distributed via a [Helm chart](https://github.com/k8up-io/k8up/tree/master/charts/k8up), compatible with [OpenShift](https://www.openshift.com/) and plain [Kubernetes](https://kubernetes.io/).
{{< /intro >}}

{{< cards count=3 >}}

{{< card >}}
## Self-Service
User self-service for backup and restore operations
{{< /card >}}

{{< card >}}
## Multi-Tenancy
Fully multi-tenant way to allow backups and restore
{{< /card >}}

{{< card >}}
## Metrics Included
See how your backups do and alert on misbehaviour
{{< /card >}}

{{< /cards >}}

{{< cards count=3 >}}

{{< card >}}
## Application Aware
Create application consistent backups
{{< /card >}}

{{< card >}}
## Data Archival
Regularly creation of data archivals to long term storage
{{< /card >}}

{{< card >}}
## Mulitple Backup Targets
Restic is used under the hood, support S3, SFTP, Rest, Local and many other targets
{{< /card >}}

{{< /cards >}}

## Facts

{{< columns >}}
{{< column >}}
It allows cluster operators to:

* Backup all PVCs marked as `ReadWriteMany`, `ReadWriteOnce` or with a specific label.
* Perform individual, on-demand backups.
* Schedule backups to be executed on a regular basis.
* Schedule archival (for example to AWS Glacier), usually executed in longer intervals.
* Perform "Application Aware" backups, containing the output of any tool capable of writing to `stdout`.
* Check the backup repository for its integrity.
* Prune old backups from a repository.
* Restore backups with the help of the k8up CLI tool.
{{< /column >}}
{{< column >}}
K8up is:

* Stable and production ready since 2019.
* Based on top of [Restic(https://restic.readthedocs.io/)], it can store backups in any S3-compatible storage, such as Amazon S3 or [Minio](https://github.com/minio/minio).
* Written in [Go](https://golang.org/).
* A [CNCF Sandbox](https://www.cncf.io/sandbox-projects/) Open Source project, [hosted at GitHub](https://github.com/k8up-io/k8up).
{{< /column >}}
{{< /columns >}}

{{< spacer >}}

{{< img src="/images/cncf.svg" >}}
6 changes: 6 additions & 0 deletions content/en/coc.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
---
title: Code of Conduct
description: The K8up community CoC
---

To learn more about our Code of Conduct, please consult the [CODE_OF_CONDUCT.md](https://github.com/k8up-io/k8up/blob/master/CODE_OF_CONDUCT.md) file.
Loading

0 comments on commit f70a419

Please sign in to comment.