Skip to content

Commit

Permalink
chore: set up MkDocs (keptn#2603)
Browse files Browse the repository at this point in the history
  • Loading branch information
mowies authored Nov 29, 2023
1 parent 3c9b97a commit fbd4601
Show file tree
Hide file tree
Showing 15 changed files with 612 additions and 1 deletion.
1 change: 1 addition & 0 deletions .github/actions/spelling/excludes.txt
Original file line number Diff line number Diff line change
Expand Up @@ -28,3 +28,4 @@ _test\.go$
^\.github/scripts/\.helm-tests/[a-zA-Z0-9-]+/result.ya?ml
^dashboards/grafana/configmap/.*\.ya?ml
^dashboards/grafana/import/.*\.json
^\Qdocs/layouts/partials/hooks/body-end.html\E$
15 changes: 15 additions & 0 deletions .github/actions/spelling/expect.txt
Original file line number Diff line number Diff line change
Expand Up @@ -142,6 +142,7 @@ docsearch
docsembed
docsy
dql
draggable
DTAPI
dtclient
dupl
Expand All @@ -152,6 +153,7 @@ elasticquota
elif
Emoji
ENABLEGITINFO
endblock
endgroup
envconfig
envsubst
Expand All @@ -175,6 +177,7 @@ favicons
fetchintervalseconds
fieldpath
fieldref
fontawesome
ftp
fullname
functionref
Expand Down Expand Up @@ -226,6 +229,7 @@ homeorchestrate
horizontalpodautoscalers
hpa
hreflang
hsla
htmltest
httpref
httpreference
Expand Down Expand Up @@ -362,9 +366,12 @@ kwv
labelledby
lastmod
lastword
Lato
lfc
Lifcycle
lifecyclekeptnsh
linecap
linejoin
linkedin
linktitle
linting
Expand Down Expand Up @@ -428,6 +435,7 @@ nodename
nolint
nonroot
noreply
nowrap
nsa
oac
oauth
Expand Down Expand Up @@ -457,6 +465,7 @@ otlpgrpc
otlptrace
otlptracegrpc
OUTDIR
overriden
owide
oyaml
pagelinks
Expand Down Expand Up @@ -498,6 +507,7 @@ providerref
providerresult
pyfunction
pygments
pymdown
pyyaml
quickstart
rangespec
Expand All @@ -513,12 +523,15 @@ replicasets
replicationcontrollers
resourcereference
Rexed
rgb
rgba
RLock
Roboto
rolebinding
rollme
roundtripper
rst
rtd
runhelloworld
RUnlock
runsendevent
Expand Down Expand Up @@ -565,7 +578,9 @@ statefultest
stdouttrace
storageclasses
storageversion
striptags
sts
stylesheet
subchart
subdir
subjectaccessreviews
Expand Down
2 changes: 2 additions & 0 deletions .github/workflows/htmltest.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -7,12 +7,14 @@ on:
- '[0-9]+.[1-9][0-9]*.x'
paths:
- 'docs/**'
- 'docs-new/**'
pull_request:
branches:
- 'main'
- '[0-9]+.[1-9][0-9]*.x'
paths:
- 'docs/**'
- 'docs-new/**'

jobs:
htmltest:
Expand Down
4 changes: 3 additions & 1 deletion .gitignore
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@
bin/
site/
.cache/

# Binaries for programs and plugins
*.exe
Expand Down Expand Up @@ -49,4 +51,4 @@ node_modules
readme-generator-for-helm/
/out.yaml
/test.yaml
**helm_tests_output.yaml
**helm_tests_output.yaml
Binary file added docs-new/assets/higher-compliance.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
24 changes: 24 additions & 0 deletions docs-new/assets/javascripts/versions.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
// VERSION WARNINGS
window.addEventListener("DOMContentLoaded", function() {
var rtdData = window['READTHEDOCS_DATA'] || { version: 'latest' };
var margin = 30;
var headerHeight = document.getElementsByClassName("md-header")[0].offsetHeight;
if (rtdData.version === "latest") {
document.querySelector("div[data-md-component=announce]").innerHTML = "<div id='announce-msg'>You are viewing the docs for an unreleased version of Keptn, <a href='https://lifecycle.keptn.sh/'>click here to go to the latest stable version.</a></div>"
var bannerHeight = document.getElementById('announce-msg').offsetHeight + margin
document.querySelector("header.md-header").style.top = bannerHeight +"px";
document.querySelector('style').textContent +=
"@media screen and (min-width: 76.25em){ .md-sidebar { height: 0; top:"+ (bannerHeight+headerHeight)+"px !important; }}"
document.querySelector('style').textContent +=
"@media screen and (min-width: 60em){ .md-sidebar--secondary { height: 0; top:"+ (bannerHeight+headerHeight)+"px !important; }}"
}
else if (rtdData.version !== "stable") {
document.querySelector("div[data-md-component=announce]").innerHTML = "<div id='announce-msg'>You are viewing the docs for a previous version of Keptn, <a href='https://lifecycle.keptn.sh/'>click here to go to the latest stable version.</a></div>"
var bannerHeight = document.getElementById('announce-msg').offsetHeight + margin
document.querySelector("header.md-header").style.top = bannerHeight +"px";
document.querySelector('style').textContent +=
"@media screen and (min-width: 76.25em){ .md-sidebar { height: 0; top:"+ (bannerHeight+headerHeight)+"px !important; }}"
document.querySelector('style').textContent +=
"@media screen and (min-width: 60em){ .md-sidebar--secondary { height: 0; top:"+ (bannerHeight+headerHeight)+"px !important; }}"
}
});
1 change: 1 addition & 0 deletions docs-new/assets/keptn-icon-white.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
210 changes: 210 additions & 0 deletions docs-new/assets/stylesheets/home.css
Original file line number Diff line number Diff line change
@@ -0,0 +1,210 @@
.md-main {
flex-grow: 0
}

.md-main__inner {
display: flex;
height: 100%;
}

.tx-container {
padding-top: .0rem;
background: linear-gradient(to bottom, var(--md-primary-fg-color), var(--md-accent-fg-color) 99%,#fff 99%)
}

.tx-hero {
margin: 32px 2.8rem;
color: var(--md-primary-bg-color);
justify-content: center;
}

.tx-hero h1 {
margin-bottom: 1rem;
color: currentColor;
font-weight: 700
}

.tx-hero__content {
padding-bottom: 1rem;
margin: 0 auto;
}

.tx-hero__image{
width:17rem;
height:17rem;
order:1;
padding-right: 2.5rem;
}

.tx-hero .md-button {
margin-top: .5rem;
margin-right: .5rem;
color: var(--md-primary-bg-color)
}

.tx-hero .md-button--primary {
background-color: var(--md-primary-bg-color);
color: hsla(280deg, 37%, 48%, 1);
border-color: var(--md-primary-bg-color)
}

.tx-hero .md-button:focus,
.tx-hero .md-button:hover {
background-color: var(--md-accent-fg-color);
color: var(--md-default-bg-color);
border-color: var(--md-accent-fg-color)
}

.feature-item h2 svg {
height: 30px;
float: left;
margin-right: 10px;
transform: translateY(10%);
}

.top-hr {
margin-top: 42px;
}

.feature-item {
font-family: 'Lato', sans-serif;
font-weight: 300;
box-sizing: border-box;
padding: 0 15px;
word-break: break-word
}

.feature-item h2 {
color: #333;
font-weight: 300;
font-size: 25px;
white-space: nowrap;
overflow: hidden;
text-overflow: ellipsis;
line-height: normal;
margin-top: 20px;
margin-bottom: 10px;
font-family: inherit;
}

.feature-item p {
font-size: 16px;
line-height: 1.8em;
text-rendering: optimizeLegibility;
-webkit-font-smoothing: antialiased;
color: #111;
margin: 0 0 10px;
display: block;
}

@media screen and (max-width:30em) {
.tx-hero h1 {
font-size: 1.4rem
}
}

@media screen and (min-width:60em) {
.md-sidebar--secondary {
display: none
}

.tx-hero {
display: flex;
align-items: center;
justify-content: center;
}

.tx-hero__content {
max-width: 22rem;
margin-top: 3.5rem;
margin-bottom: 3.5rem;
margin-left: 1.0rem;
margin-right: 4.0rem;
align-items: center;
}
}

@media screen and (min-width:76.25em) {
.md-sidebar--primary {
display: none
}

.top-hr {
width: 100%;
display: flex;
max-width: 61rem;
margin-right: auto;
margin-left: auto;
padding: 0 .2rem;
}

.bottom-hr {
margin-top: 10px;
width: 100%;
display: flex;
max-width: 61rem;
margin-right: auto;
margin-left: auto;
padding: 0 .2rem;
}

.feature-item {
flex: 1;
min-width: 0;
}

.feature-item:hover {
background-color: #526cfe47;
border-radius: 3px;
}
}

.hr {
border-bottom: 1px solid #eee;
width: 100%;
margin: 20px 0;
}

.text-center {
text-align: center;
padding-right: 15px;
padding-left: 15px;
margin-right: auto;
margin-left: auto;
margin-top: 15px;
font-family: 'Lato', sans-serif;
font-size: 23px;
font-weight: 300;
padding-bottom: 10px;
}

.logos {
display: flex;
align-items: center;
justify-content: center;
flex-flow: row wrap;
margin: 0 auto;
}

.logos img {
flex: 1 1 auto;
padding: 25px;
max-height: 130px;
vertical-align: middle;
}

.hr-logos {
margin-top: 0;
margin-bottom: 30px;
}

.md-footer-meta__inner {
display: flex;
flex-wrap: wrap;
justify-content: space-between;
margin-top: 1.0rem;
}

.md-footer-social {
padding-top: 20px;
}
Loading

0 comments on commit fbd4601

Please sign in to comment.