Skip to content

Commit

Permalink
docs: improve landing page, based on slides (#1272)
Browse files Browse the repository at this point in the history
Co-authored-by: Giovanni Liva <[email protected]>
Co-authored-by: Moritz Wiesinger <[email protected]>
  • Loading branch information
3 people authored Apr 27, 2023
1 parent b5f4e91 commit 117cda4
Show file tree
Hide file tree
Showing 13 changed files with 266 additions and 5 deletions.
3 changes: 3 additions & 0 deletions .github/mlc_config.json
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,9 @@
"ignorePatterns": [
{
"pattern": "^http://localhost"
},
{
"pattern": "^/images/why-keptn"
}
],
"timeout": "20s",
Expand Down
100 changes: 100 additions & 0 deletions docs/assets/scss/_variables_project.scss
Original file line number Diff line number Diff line change
@@ -0,0 +1,100 @@
.td-navbar .navbar-brand__name {
display: none;
}

$primary: #006bb8;
$secondary: #469bdd;
$light: #d8e6f4;

#td-cover-block-0 {
background-size: 100% auto;
background-position-y: bottom;
}

a.btn-primary {
background: #28a745 linear-gradient(180deg, #30c953, #28a745) repeat-x;
border-color: #28a745;
box-shadow: inset 0 1px 0 rgba(255, 255, 255, 0.15), 0 1px 1px rgba(0, 0, 0, 0.075);
color: #ffffff !important
}

a.btn-primary:hover {
color: #fff;
background: #23923d linear-gradient(180deg, #28a745, #23923d) repeat-x;
border-color: #23923d;
}

.home::before {
content: '';
height: 128px;
width: 170px;
display: block;
background-position: center middle;
background-color: #d8e6f4;
border-radius: 25px;
}

.homeorchestrate::before {
background-image: url('/images/home/capabilities/capabilities-03.svg');
}
.homeobservability::before {
background-image: url('/images/home/capabilities/capabilities-04.svg');
}
.homedata::before {
background-image: url('/images/home/capabilities/capabilities-01.svg');
}
.td-overlay--dark::after {
background-color: transparent !important;
}

.whykeptn img {
width: 100%;
}
.whykeptn {
text-align: left;
}
.whykeptn h2::after {
display: block;
content: " ";
width: 80px;
margin-top: 24px;
margin-bottom: 24px;
margin-left: 0;
border-bottom: 4px solid #006bb8;
}

.whykeptn-left {
text-align: left;
}
.whykeptn-right {
text-align: left;
}

@font-face {
font-family: 'Ubuntu';
src: url("/Ubuntu-Medium.ttf");
}


$fontFamilyStyled: Ubuntu, -apple-system, BlinkMacSystemFont, "Segoe UI", Roboto, "Helvetica Neue", Arial, sans-serif, "Apple Color Emoji", "Segoe UI Emoji", "Segoe UI Symbol";
.td-main h1, .styled {
font-family: $fontFamilyStyled
}
.usecasebox {
margin-top: 50px;
background-image: linear-gradient(180deg, rgba(0, 107, 184, 0.0), rgba(0, 107, 184, 0.50));
border-radius: 25px;
padding: 20px;
}

.navbar-logo::after {
content: "Lifecycle Toolkit";
font-size: 23px;
font-weight: 700;
font-family: $fontFamilyStyled;
line-height: 30px;
height: 30px;
vertical-align: bottom;
padding-top: 2px;
display: inline-block
}
8 changes: 8 additions & 0 deletions docs/config/_default/config.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -32,3 +32,11 @@ languages:
en:
title: Keptn
contentDir: "content/en"

menu:
main:
- name: Keptn v1
params:
rel: external
url: https://keptn.sh/
weight: 1
114 changes: 109 additions & 5 deletions docs/content/en/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,23 +25,127 @@ cascade:
weight: 20
---

<!-- markdownlint-disable MD033 -->
<!-- markdownlint-disable no-inline-html -->
<!-- markdownlint-disable-next-line line-length -->
{{< blocks/cover title="Welcome to the Keptn Lifecycle Toolkit Documentation" image_anchor="top" height="half" color="primary" >}}
{{< blocks/cover title="" image_anchor="top" height="full" color="primary" >}}
<div class="mx-auto">
<div class="mb-4 d-none d-md-block " >
<picture >
<img alt="keptn" src="/images/home/hero/keptn-logo-white.svg">
</picture>
</div>
<h1 class="display-1 mt-0 mt-md-5 pb-4">Lifecycle Toolkit</h1>
<h2 class="styled display-3 mt-0 mb-4">Cloud native application lifecycle orchestration </h2>
<div>
<a class="btn btn-lg btn-primary mr-3 mb-4" href="{{< relref "/docs" >}}">
Docs <i class="fas fa-arrow-alt-circle-right ml-2"></i>
</a>
<a class="btn btn-lg btn-primary mr-3 mb-4" href="https://github.com/keptn/lifecycle-toolkit/releases">
<a class="btn btn-lg btn-secondary mr-3 mb-4" href="https://github.com/keptn/lifecycle-toolkit/releases">
Releases <i class="fab fa-github ml-2 "></i>
</a>
</div>
</div>
<div class="usecasebox">

## Use Cases

We extend the K8s APIs with the following Use Cases:

<div class="row usecases">
{{% blocks/feature icon="home homeobservability" title="Deployment Observability" %}}
Make ANY Kubernetes Deployment observable

<!-- markdownlint-disable-next-line link-fragments -->
<a class="btn btn-lg -bg-light mr-3 mb-4" href="#deployment-observability">
read more <i class="fas fa-arrow-alt-circle-down ml-2"></i>
</a>
{{% /blocks/feature %}}
{{% blocks/feature icon="home homedata" title="Deployment Data Access" %}}
Standardize access for all Observability Data for K8s

<!-- markdownlint-disable-next-line link-fragments -->
<a class="btn btn-lg -bg-light mr-3 mb-4" href="#data-access">
read more <i class="fas fa-arrow-alt-circle-down ml-2"></i>
</a>
{{% /blocks/feature %}}

{{% blocks/feature icon="home homeorchestrate" title="Orchestrate Deployment Checks" %}}
Gain confidence in your work with pre-/post-deployment checks

<!-- markdownlint-disable-next-line link-fragments -->
<a class="btn btn-lg -bg-light mr-3 mb-4" href="#deployment-check-orchestration">
read more <i class="fas fa-arrow-alt-circle-down ml-2"></i>
</a>
{{% /blocks/feature %}}

</div>
</div>

{{< /blocks/cover >}}
<!-- markdownlint-enable MD033 -->
<!-- markdownlint-enable no-inline-html -->

{{% blocks/lead color="light" %}}

{{< youtube K-cvnZ8EtGc >}}

{{% /blocks/lead %}}

<!-- markdownlint-disable no-inline-html -->
{{% blocks/lead color="white"%}}
<div class="mx-auto">
<div class="d-flex flex-row flex-wrap" >
<div class="whykeptn whykeptn-left">
{{% readfile "partials/_index-observability-left.md" %}}
</div>
<div class="whykeptn whykeptn-right w-25">
{{% readfile "partials/_index-observability-right.md" %}}
</div>
</div>
<a class="btn -bg-green" href="./docs/getting-started/">
Get Started!
</a>
</div>

{{% /blocks/lead %}}
<!-- markdownlint-enable no-inline-html -->

<!-- markdownlint-disable no-inline-html -->
{{% blocks/lead color="light" %}}
<div class="mx-auto">
<div class="d-flex flex-row flex-wrap" >
<div class="whykeptn whykeptn-left w-25">
{{% readfile "partials/_index-data-access-left.md" %}}
</div>
<div class="whykeptn whykeptn-right ">
{{% readfile "partials/_index-data-access-right.md" %}}
</div>
</div>
<a class="btn -bg-green" href="./docs/getting-started/">
Get Started!
</a>
</div>
{{% /blocks/lead %}}
<!-- markdownlint-enable no-inline-html -->

<!-- markdownlint-disable no-inline-html -->
{{% blocks/lead color="white" %}}
[![Keptn Lifecycle Toolkit in a Nutshell](https://img.youtube.com/vi/K-cvnZ8EtGc/0.jpg)](https://www.youtube.com/watch?v=K-cvnZ8EtGc)
<div class="mx-auto">
<div class="d-flex flex-row flex-wrap" >
<div class="whykeptn whykeptn-left">
{{% readfile "partials/_index-deployment-checks-left.md" %}}
</div>
<div class="whykeptn whykeptn-right w-25 text-center">
{{% readfile "partials/_index-deployment-checks-right.md" %}}
</div>
</div>
<a class="btn -bg-green" href="./docs/getting-started/">
Get Started!
</a>
</div>

{{% /blocks/lead %}}
<!-- markdownlint-enable no-inline-html -->

{{< blocks/section color="dark" >}}
{{% blocks/feature icon="fa-lightbulb" title="Keptn Recordings" %}}
See Keptn in Action
Expand Down
Binary file added docs/content/en/intro-background.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 2 additions & 0 deletions docs/content/en/partials/.markdownlint-cli2.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
config:
first-line-heading: false
2 changes: 2 additions & 0 deletions docs/content/en/partials/_index-data-access-left.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@

![Higher Compliance](/images/why-keptn/higher-compliance.png)
10 changes: 10 additions & 0 deletions docs/content/en/partials/_index-data-access-right.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@

## Data Access

### Standardizing access for all Observability Data for K8s

The Keptn Metrics Server provides:

* Define Keptn Metrics once for Dynatrace, DataDog, AWS, Azure, GCP, ...
* Access all those metrics via Prometheus or K8s Metric API
* Eliminate the need of multiple plugins for Argo Roolouts, KEDA, HPA, ...
17 changes: 17 additions & 0 deletions docs/content/en/partials/_index-deployment-checks-left.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@

## Deployment Check Orchestration

### Orchestrating deployment checks

To reduce complexity of custom checks use Keptn to:

* Pre-Deploy:
* Validate external dependencies
* Confirm images are scanned
* ...
* Post-Deploy:
* Execute tests
* Notify Stakeholders
* Promote to next stage
* ...
* Automatically validate against your SLOs (Service Level Objectives)
2 changes: 2 additions & 0 deletions docs/content/en/partials/_index-deployment-checks-right.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@

![Maintenance](/images/why-keptn/maintenance.png)
11 changes: 11 additions & 0 deletions docs/content/en/partials/_index-observability-left.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@

## Deployment Observability

### Making ANY K8s Deployment OBSERVABLE

If you deploy with ArcoCD, Flux, GitLab, kubectl, etc.
we provide you:

* Automated **App-Aware DORA** metrics (OTel Metrics)
* Troubleshoort failed deployments (OTel Traces)
* Trace deployments from Git to cloud (traces across stages)
2 changes: 2 additions & 0 deletions docs/content/en/partials/_index-observability-right.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@

![Observability](/images/why-keptn/observability.png)
Binary file added docs/static/Ubuntu-Medium.ttf
Binary file not shown.

0 comments on commit 117cda4

Please sign in to comment.