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

feat: Add initial docs site setup #37

Merged
merged 6 commits into from
Mar 20, 2024
Merged
Show file tree
Hide file tree
Changes from 3 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
4 changes: 4 additions & 0 deletions site/.gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
/public
resources/
node_modules/
.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/*
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>
63 changes: 63 additions & 0 deletions site/content/en/community/_index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,63 @@
---
title: Community
description: Welcome to the etcd user and developer community page
menu:
main:
---

{{< blocks/cover color="primary" height="sm" >}}
{{< page/header >}}
{{< /blocks/cover >}}

<div class="container l-container--padded">

<div class="row">
{{< page/toc collapsed=true placement="inline" >}}
</div>

<div class="row">
<div class="col-12 col-lg-8">

{{% alert color="success" %}}
<i class='fas fa-users mr-1'></i> Our community values respect and
inclusiveness. We enforce our [Code of Conduct][] in all interactions.

[Code of Conduct]: https://github.com/cncf/foundation/blob/master/code-of-conduct.md
{{% /alert %}}

{{% community-lists %}}

## Community meetings

etcd-operator contributors and maintainers meet [online][] every week, on **Tuesday
at 5 PM** [Central Europe Time][], alternating between community meetings and issue
triage meetings. Issue triage meetings are aimed at getting through our backlog
of PRs and Issues. Triage meetings are open to any contributor; you don't have
to be a reviewer or approver to help out! They can also be a good way to get
started contributing.

For phone-in information, the date of the next meeting, and minutes from past
meetings, see [etcd-operator community meeting][meeting-doc].

## Contributing

Your contributions to etcd-operator code and documentation are welcome! If you find a
problem or would like an enhancement, create an issue -- or better yet, consider
submitting a pull request.

For etcd contribution guidelines, see [How to contribute][].

</div>

{{< page/toc placement="sidebar" >}}

</div>

{{< page/page-meta-links >}}

</div>

[How to contribute]: https://github.com/aenix-io/etcd-operator/blob/main/CONTRIBUTING.md
[meeting-doc]: https://docs.google.com/document/d/1coiWlHOVfPAIyKqtfpYLhq9eeRPHCuuMxmNmVfo9-sA/edit#heading=h.ygb3chatmgn2
[online]: https://meet.google.com/fmn-sogk-ofb
[Central Europe Time]: https://www.timeanddate.com/time/zones/cet
9 changes: 9 additions & 0 deletions site/content/en/docs/_index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
---
title: Documentation versions
linkTitle: Documentation
simple_list: true
menu:
main:
---

Welcome to the docs for etcd-operator! The following doc versions are available:
Loading