Skip to content

Commit 8d9f71d

Browse files
sergeyshevchsergeyshevch
committed
feat: Add initial docs site setup
1 parent b984cad commit 8d9f71d

36 files changed

+882
-0
lines changed

‎site/.gitignore‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
/public
2+
resources/
3+
node_modules/
4+
package-lock.json
5+
.hugo_build.lock

‎site/.nvmrc‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
lts/*

‎site/Dockerfile‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
FROM floryn90/hugo:ext-alpine
2+
3+
RUN apk add git && \
4+
git config --global --add safe.directory /src

‎site/assets/scss/_styles_project.scss‎

Lines changed: 254 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,254 @@
1+
/* etcd-docsy full file override: we're not tracking changes to the docsy file of the same name. */
2+
3+
.td-home {
4+
h1 {
5+
// @extend .display-1;
6+
margin-bottom: 2.5rem;
7+
text-align: center;
8+
}
9+
10+
h2 {
11+
// @extend .display-2;
12+
margin-bottom: 1.5rem;
13+
text-align: center;
14+
}
15+
16+
h3 {
17+
//@extend .display-3;
18+
}
19+
20+
h4 {
21+
// @extend .display-4;
22+
margin-bottom: 1rem;
23+
}
24+
25+
.home--top-section {
26+
text-align: center;
27+
}
28+
29+
.cncf-logo {
30+
width: 20rem;
31+
max-width: 80%;
32+
}
33+
34+
.site-logo {
35+
max-height: 8rem;
36+
max-width: 65%;
37+
}
38+
}
39+
40+
// Components and objects
41+
42+
.c-features {
43+
display: flex;
44+
flex-direction: column;
45+
flex-wrap: wrap;
46+
justify-content: center;
47+
48+
h3 {
49+
color: $etcd-dark-blue;
50+
}
51+
}
52+
53+
.o-features__feature {
54+
display: inline-flex;
55+
flex-direction: column;
56+
57+
margin-bottom: 1.5rem;
58+
padding-left: 1rem;
59+
padding-right: 1rem;
60+
61+
h3 {
62+
margin-bottom: 1.5rem;
63+
}
64+
}
65+
66+
.o-feature__icon {
67+
width: 100%;
68+
margin-left: auto;
69+
margin-right: auto;
70+
margin-top: 1rem;
71+
max-width: 15rem;
72+
max-height: 10rem;
73+
}
74+
75+
.o-icon {
76+
margin-right: 0.25rem;
77+
}
78+
79+
.used-by-logo {
80+
max-height: 4rem;
81+
max-width: 100%;
82+
}
83+
84+
.c-used-by__users {
85+
display: flex;
86+
flex-direction: column;
87+
flex-wrap: wrap;
88+
align-items: center;
89+
margin-bottom: -3rem;
90+
}
91+
92+
.c-used-by__user {
93+
margin-left: auto;
94+
margin-right: auto;
95+
padding-left: 1.5rem;
96+
padding-right: 1.5rem;
97+
padding-bottom: 3rem;
98+
}
99+
100+
@include media-breakpoint-up(sm) {
101+
.c-features {
102+
padding-right: 3rem;
103+
padding-left: 3rem;
104+
}
105+
}
106+
107+
@include media-breakpoint-up(md) {
108+
.c-features {
109+
flex-direction: row;
110+
}
111+
112+
.c-used-by__users {
113+
flex-direction: row;
114+
justify-content: between;
115+
}
116+
117+
.c-used-by__user {
118+
padding-bottom: 1.5rem;
119+
}
120+
}
121+
122+
// Bootstrap and Docsy overrides
123+
124+
.alert > p:last-child {
125+
margin-bottom: 0;
126+
}
127+
128+
// Utilities
129+
130+
.bg-gray-100 {
131+
background-color: $gray-100;
132+
}
133+
134+
// Fixes https://github.com/etcd-io/website/issues/266: the docsy partial
135+
// shouldn't be hard coding styles by using classes like "text-uppercase". This
136+
// overrides the docsy styling.
137+
.navbar-brand > .text-uppercase {
138+
text-transform: initial !important;
139+
}
140+
141+
142+
// Layout
143+
.l-container--padded {
144+
padding-top: 2rem;
145+
padding-bottom: 2rem;
146+
}
147+
148+
149+
// DOCS
150+
151+
.td-toc {
152+
padding-top: 1rem;
153+
}
154+
155+
// Extend the sidebar to the end of the visible page.
156+
.td-sidebar-toc {
157+
height: initial;
158+
padding-top: 4.75rem;
159+
}
160+
161+
.td-sidebar-nav__section {
162+
.ul-1 ul { padding-left: 1rem; }
163+
.ul-2 { padding-left: 0 !important; }
164+
}
165+
166+
// Custom in-page toc. Apply this class as a modifier on top of the Docsy-provided .td-toc
167+
.td-toc--inline {
168+
padding-top: 0;
169+
padding-bottom: 1rem;
170+
border-left: none;
171+
position: static;
172+
height: auto;
173+
174+
& + .td-content {
175+
margin-top: 1.5rem;
176+
}
177+
178+
// Workaround to prevent the first three entries from being hidden
179+
& #td-content__toc.collapse:not(.show) {
180+
display: block;
181+
overflow: hidden;
182+
min-height: 5.5rem;
183+
height: 5.5rem;
184+
}
185+
186+
& #td-content__toc.collapsing {
187+
height: 5rem;
188+
}
189+
190+
& #td-content__toc.collapse:not(.show) + #td-content__toc-link-expanded::before,
191+
& #toc-contents.collapse:not(.show) + #td-content__toc-link-expanded::before {
192+
content: "…";
193+
}
194+
195+
& #td-content__toc.collapse.show + #td-content__toc-link-expanded::before,
196+
& #toc-contents + #td-content__toc-link-expanded::before {
197+
content: "\2303";
198+
}
199+
}
200+
201+
#td-content__toc-link span i.fa-chevron-right {
202+
transition: transform 250ms ease-in-out;
203+
}
204+
205+
#td-content__toc-link[aria-expanded="true"] span i.fa-chevron-right {
206+
transform: rotate(-90deg);
207+
}
208+
209+
#td-content__toc-link-expanded {
210+
background-color: $gray-200;
211+
}
212+
213+
// add icon to signify that a link is external
214+
// from https://fontawesome.com/v5.15/icons/external-link-alt?style=solid
215+
216+
.td-content a[href^="http://"]:after,
217+
.td-content a[href^="https://"]:after {
218+
@extend .fas;
219+
font-size: 50%;
220+
margin-left: 1px;
221+
opacity: 0.8;
222+
vertical-align: text-top;
223+
content: fa-content($fa-var-external-link-alt);
224+
}
225+
226+
.card-title {
227+
.fab::before, .fas::before { margin-right: .5rem; }
228+
}
229+
230+
// ************************************
231+
// Version menu
232+
// ************************************
233+
234+
.cncf-vers-menu--item {
235+
&:hover {
236+
background: $primary;
237+
color: white;
238+
}
239+
}
240+
241+
.cncf-vers-menu--item__not-found {
242+
color: $gray-600;
243+
&:hover {
244+
background: lighten($primary, 60%);
245+
color: $gray-900;
246+
}
247+
&:after {
248+
@extend .fas;
249+
font-size: .8rem;
250+
padding-left: 6px;
251+
content: fa-content($fa-var-home);
252+
color: lighten($primary, 15%);
253+
}
254+
}

‎site/assets/scss/_variables_project.scss‎

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
/*
2+
3+
Add styles or override variables from the theme here.
4+
5+
*/
6+
7+
/* etcd-docsy full file override: we're not tracking changes to the docsy base file. */
8+
9+
$etcd-blue: #419eda;
10+
$etcd-light-blue: lighten($etcd-blue, 10%);
11+
$etcd-dark-blue: darken($etcd-blue, 20%);
12+
13+
$primary: $etcd-dark-blue;
14+
$secondary: $etcd-light-blue;
15+
$_yellow: #ffc107;
16+
$warning: $_yellow; // Use Bootstrap default

‎site/content/en/_index.md‎

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
---
2+
title: etcd operator
3+
features:
4+
- title: Simple interface
5+
description: Run etcd clusters in Kubernetes within minutes
6+
- title: Customizable
7+
description: Customize your cluster deployment to fit your needs
8+
- title: Watch for changes
9+
description: Automatically update your etcd clusters when changes are detected
10+
---
11+
12+
{{< blocks/cover image_anchor="top" height="min" color="primary" >}}
13+
<h2 class="mt-4">
14+
Operator that manages etcd in your Kubernetes cluster
15+
</h2>
16+
<a class="btn btn-lg btn-primary me-3 mb-4" href="/docs/{{< param version >}}/">
17+
Learn More <i class="fas fa-arrow-alt-circle-right ms-2"></i>
18+
</a>
19+
<a class="btn btn-lg btn-secondary me-3 mb-4" href="/docs/{{< param version >}}/quickstart">
20+
Quickstart <i class="fab fa-github ms-2 "></i>
21+
</a>
22+
{{< /blocks/cover >}}
23+
24+
25+
{{% blocks/lead color="white" %}}
26+
<h1>What is etcd-operator?</h1>
27+
<p>
28+
<b>etcd-operator</b> is a Kubernetes operator that
29+
provides a suitable and reliable way to manage etcd clusters inside Kubernetes.
30+
<a href="/docs/{{< param version >}}/">Learn more<i class="fas fa-arrow-alt-circle-right ml-2"></i></a>
31+
</p>
32+
{{% /blocks/lead %}}
33+
34+
<div class="container">
35+
{{< home/features >}}
36+
{{< home/used-by >}}
37+
</div>

‎site/content/en/community/_index.md‎

Lines changed: 64 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,64 @@
1+
---
2+
title: Community
3+
description: Welcome to the etcd user and developer community page
4+
menu:
5+
main:
6+
---
7+
8+
{{< blocks/cover color="primary" height="sm" >}}
9+
{{< page/header >}}
10+
{{< /blocks/cover >}}
11+
12+
<div class="container l-container--padded">
13+
14+
<div class="row">
15+
{{< page/toc collapsed=true placement="inline" >}}
16+
</div>
17+
18+
<div class="row">
19+
<div class="col-12 col-lg-8">
20+
21+
{{% alert color="success" %}}
22+
<i class='fas fa-users mr-1'></i> Our community values respect and
23+
inclusiveness. We enforce our [Code of Conduct][] in all interactions.
24+
25+
[Code of Conduct]: https://github.com/cncf/foundation/blob/master/code-of-conduct.md
26+
{{% /alert %}}
27+
28+
{{% community-lists %}}
29+
30+
## Community meetings
31+
32+
etcd-operator contributors and maintainers meet [online][] every week, on **Tuesday
33+
at 5 PM** [Central Europe Time][], alternating between community meetings and issue
34+
triage meetings. Issue triage meetings are aimed at getting through our backlog
35+
of PRs and Issues. Triage meetings are open to any contributor; you don't have
36+
to be a reviewer or approver to help out! They can also be a good way to get
37+
started contributing.
38+
39+
For phone-in information, the date of the next meeting, and minutes from past
40+
meetings, see [etcd-operator community meeting][meeting-doc].
41+
42+
## Contributing
43+
44+
Your contributions to etcd-operator code and documentation are welcome! If you find a
45+
problem or would like an enhancement, create an issue -- or better yet, consider
46+
submitting a pull request.
47+
48+
For etcd contribution guidelines, see [How to contribute][].
49+
50+
</div>
51+
52+
{{< page/toc placement="sidebar" >}}
53+
54+
</div>
55+
56+
{{< page/page-meta-links >}}
57+
58+
</div>
59+
60+
[How to contribute]: https://github.com/aenix-io/etcd-operator/blob/main/CONTRIBUTING.md
61+
[meeting-doc]: https://docs.google.com/document/d/1coiWlHOVfPAIyKqtfpYLhq9eeRPHCuuMxmNmVfo9-sA/edit#heading=h.ygb3chatmgn2
62+
[online]: https://meet.google.com/fmn-sogk-ofb
63+
[Central Europe Time]: https://www.timeanddate.com/time/zones/cet
64+

‎site/content/en/docs/_index.md‎

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
---
2+
title: Documentation versions
3+
linkTitle: Documentation
4+
simple_list: true
5+
menu:
6+
main:
7+
---
8+
9+
Welcome to the docs for etcd-operator! The following doc versions are available:

0 commit comments

Comments
 (0)