Skip to content

Commit

Permalink
feat: Add initial docs site setup
Browse files Browse the repository at this point in the history
  • Loading branch information
sergeyshevch committed Mar 18, 2024
1 parent b984cad commit db7ae87
Show file tree
Hide file tree
Showing 37 changed files with 910 additions and 0 deletions.
5 changes: 5 additions & 0 deletions site/.gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
/public
resources/
node_modules/
package-lock.json
.hugo_build.lock
1 change: 1 addition & 0 deletions site/.nvmrc
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
lts/*
28 changes: 28 additions & 0 deletions site/CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
# How to Contribute

We'd love to accept your patches and contributions to this project. There are
just a few small guidelines you need to follow.

## Contributor License Agreement

Contributions to this project must be accompanied by a Contributor License
Agreement. You (or your employer) retain the copyright to your contribution;
this simply gives us permission to use and redistribute your contributions as
part of the project. Head over to <https://cla.developers.google.com/> to see
your current agreements on file or to sign a new one.

You generally only need to submit a CLA once, so if you've already submitted one
(even if it was for a different project), you probably don't need to do it
again.

## Code reviews

All submissions, including submissions by project members, require review. We
use GitHub pull requests for this purpose. Consult
[GitHub Help](https://help.github.com/articles/about-pull-requests/) for more
information on using pull requests.

## Community Guidelines

This project follows
[Google's Open Source Community Guidelines](https://opensource.google.com/conduct/).
4 changes: 4 additions & 0 deletions site/Dockerfile
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
FROM floryn90/hugo:ext-alpine

RUN apk add git && \
git config --global --add safe.directory /src
254 changes: 254 additions & 0 deletions site/assets/scss/_styles_project.scss
Original file line number Diff line number Diff line change
@@ -0,0 +1,254 @@
/* etcd-docsy full file override: we're not tracking changes to the docsy file of the same name. */

.td-home {
h1 {
// @extend .display-1;
margin-bottom: 2.5rem;
text-align: center;
}

h2 {
// @extend .display-2;
margin-bottom: 1.5rem;
text-align: center;
}

h3 {
//@extend .display-3;
}

h4 {
// @extend .display-4;
margin-bottom: 1rem;
}

.home--top-section {
text-align: center;
}

.cncf-logo {
width: 20rem;
max-width: 80%;
}

.site-logo {
max-height: 8rem;
max-width: 65%;
}
}

// Components and objects

.c-features {
display: flex;
flex-direction: column;
flex-wrap: wrap;
justify-content: center;

h3 {
color: $etcd-dark-blue;
}
}

.o-features__feature {
display: inline-flex;
flex-direction: column;

margin-bottom: 1.5rem;
padding-left: 1rem;
padding-right: 1rem;

h3 {
margin-bottom: 1.5rem;
}
}

.o-feature__icon {
width: 100%;
margin-left: auto;
margin-right: auto;
margin-top: 1rem;
max-width: 15rem;
max-height: 10rem;
}

.o-icon {
margin-right: 0.25rem;
}

.used-by-logo {
max-height: 4rem;
max-width: 100%;
}

.c-used-by__users {
display: flex;
flex-direction: column;
flex-wrap: wrap;
align-items: center;
margin-bottom: -3rem;
}

.c-used-by__user {
margin-left: auto;
margin-right: auto;
padding-left: 1.5rem;
padding-right: 1.5rem;
padding-bottom: 3rem;
}

@include media-breakpoint-up(sm) {
.c-features {
padding-right: 3rem;
padding-left: 3rem;
}
}

@include media-breakpoint-up(md) {
.c-features {
flex-direction: row;
}

.c-used-by__users {
flex-direction: row;
justify-content: between;
}

.c-used-by__user {
padding-bottom: 1.5rem;
}
}

// Bootstrap and Docsy overrides

.alert > p:last-child {
margin-bottom: 0;
}

// Utilities

.bg-gray-100 {
background-color: $gray-100;
}

// Fixes https://github.com/etcd-io/website/issues/266: the docsy partial
// shouldn't be hard coding styles by using classes like "text-uppercase". This
// overrides the docsy styling.
.navbar-brand > .text-uppercase {
text-transform: initial !important;
}


// Layout
.l-container--padded {
padding-top: 2rem;
padding-bottom: 2rem;
}


// DOCS

.td-toc {
padding-top: 1rem;
}

// Extend the sidebar to the end of the visible page.
.td-sidebar-toc {
height: initial;
padding-top: 4.75rem;
}

.td-sidebar-nav__section {
.ul-1 ul { padding-left: 1rem; }
.ul-2 { padding-left: 0 !important; }
}

// Custom in-page toc. Apply this class as a modifier on top of the Docsy-provided .td-toc
.td-toc--inline {
padding-top: 0;
padding-bottom: 1rem;
border-left: none;
position: static;
height: auto;

& + .td-content {
margin-top: 1.5rem;
}

// Workaround to prevent the first three entries from being hidden
& #td-content__toc.collapse:not(.show) {
display: block;
overflow: hidden;
min-height: 5.5rem;
height: 5.5rem;
}

& #td-content__toc.collapsing {
height: 5rem;
}

& #td-content__toc.collapse:not(.show) + #td-content__toc-link-expanded::before,
& #toc-contents.collapse:not(.show) + #td-content__toc-link-expanded::before {
content: "";
}

& #td-content__toc.collapse.show + #td-content__toc-link-expanded::before,
& #toc-contents + #td-content__toc-link-expanded::before {
content: "\2303";
}
}

#td-content__toc-link span i.fa-chevron-right {
transition: transform 250ms ease-in-out;
}

#td-content__toc-link[aria-expanded="true"] span i.fa-chevron-right {
transform: rotate(-90deg);
}

#td-content__toc-link-expanded {
background-color: $gray-200;
}

// add icon to signify that a link is external
// from https://fontawesome.com/v5.15/icons/external-link-alt?style=solid

.td-content a[href^="http://"]:after,
.td-content a[href^="https://"]:after {
@extend .fas;
font-size: 50%;
margin-left: 1px;
opacity: 0.8;
vertical-align: text-top;
content: fa-content($fa-var-external-link-alt);
}

.card-title {
.fab::before, .fas::before { margin-right: .5rem; }
}

// ************************************
// Version menu
// ************************************

.cncf-vers-menu--item {
&:hover {
background: $primary;
color: white;
}
}

.cncf-vers-menu--item__not-found {
color: $gray-600;
&:hover {
background: lighten($primary, 60%);
color: $gray-900;
}
&:after {
@extend .fas;
font-size: .8rem;
padding-left: 6px;
content: fa-content($fa-var-home);
color: lighten($primary, 15%);
}
}
16 changes: 16 additions & 0 deletions site/assets/scss/_variables_project.scss
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
/*
Add styles or override variables from the theme here.
*/

/* etcd-docsy full file override: we're not tracking changes to the docsy base file. */

$etcd-blue: #419eda;
$etcd-light-blue: lighten($etcd-blue, 10%);
$etcd-dark-blue: darken($etcd-blue, 20%);

$primary: $etcd-dark-blue;
$secondary: $etcd-light-blue;
$_yellow: #ffc107;
$warning: $_yellow; // Use Bootstrap default
37 changes: 37 additions & 0 deletions site/content/en/_index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
---
title: etcd operator
features:
- title: Simple interface
description: Run etcd clusters in Kubernetes within minutes
- title: Customizable
description: Customize your cluster deployment to fit your needs
- title: Watch for changes
description: Automatically update your etcd clusters when changes are detected
---

{{< blocks/cover image_anchor="top" height="min" color="primary" >}}
<h2 class="mt-4">
Operator that manages etcd in your Kubernetes cluster
</h2>
<a class="btn btn-lg btn-primary me-3 mb-4" href="/docs/{{< param version >}}/">
Learn More <i class="fas fa-arrow-alt-circle-right ms-2"></i>
</a>
<a class="btn btn-lg btn-secondary me-3 mb-4" href="/docs/{{< param version >}}/quickstart">
Quickstart <i class="fab fa-github ms-2 "></i>
</a>
{{< /blocks/cover >}}


{{% blocks/lead color="white" %}}
<h1>What is etcd-operator?</h1>
<p>
<b>etcd-operator</b> is a Kubernetes operator that
provides a suitable and reliable way to manage etcd clusters inside Kubernetes.
<a href="/docs/{{< param version >}}/">Learn more<i class="fas fa-arrow-alt-circle-right ml-2"></i></a>
</p>
{{% /blocks/lead %}}

<div class="container">
{{< home/features >}}
{{< home/used-by >}}
</div>
Loading

0 comments on commit db7ae87

Please sign in to comment.