Skip to content

Commit 6fcf924

Browse files
anmol372anmol372
authored andcommitted
Improve look and feel of olm site
Changes: 1. Added styling imports from themes/docsy 2. Corrected font family, sizing, and letter-spacing for docs 3. Increased size of headings on the site to make them larger than their subtexts.
1 parent 434377b commit 6fcf924

File tree

10 files changed

+139
-28
lines changed

10 files changed

+139
-28
lines changed

assets/scss/_docs.scss

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,8 @@
1717
h1,h2,h3,h4,h5,h6 {
1818
color: var(--of--Color--brand--200);
1919
font-weight: 800;
20-
margin: var(--of--spacer--md) 0 var(--of--spacer--sm);
20+
letter-spacing: 2px;
21+
//margin: var(--of--spacer--md) 0 var(--of--spacer--sm);
2122

2223
a:hover {
2324
text-decoration: none;

assets/scss/_styles_project.scss

Lines changed: 61 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,64 @@
1+
@import "../../themes/docsy/assets/scss/support/functions";
2+
@import "../../themes/docsy/assets/scss/bs-variables";
3+
@import "../../themes/docsy/assets/scss/support/mixins";
4+
5+
@import "../../themes/docsy/assets/vendor/bootstrap/scss/bootstrap";
6+
//@import "../../themes/docsy/assets/vendor/bootstrap/scss/reboot";
7+
8+
@import "../../themes/docsy/assets/vendor/Font-Awesome/scss/fontawesome.scss";
9+
@import "../../themes/docsy/assets/vendor/Font-Awesome/scss/solid.scss";
10+
@import "../../themes/docsy/assets/vendor/Font-Awesome/scss/brands.scss";
11+
12+
@import "../../themes/docsy/assets/scss/support/utilities";
13+
@import "../../themes/docsy/assets/scss/colors";
14+
@import "../../themes/docsy/assets/scss/boxes";
15+
@import "../../themes/docsy/assets/scss/blog";
16+
@import "../../themes/docsy/assets/scss/code";
17+
@import "../../themes/docsy/assets/scss/nav";
18+
@import "../../themes/docsy/assets/scss/sidebar-tree";
19+
@import "../../themes/docsy/assets/scss/sidebar-toc";
20+
@import "../../themes/docsy/assets/scss/buttons";
21+
@import "../../themes/docsy/assets/scss/breadcrumb";
22+
@import "../../themes/docsy/assets/scss/alerts";
23+
@import "../../themes/docsy/assets/scss/content";
24+
@import "../../themes/docsy/assets/scss/search";
25+
@import "../../themes/docsy/assets/scss/main-container";
26+
@import "../../themes/docsy/assets/scss/blocks/blocks";
27+
@import "../../themes/docsy/assets/scss/section-index";
28+
@import "../../themes/docsy/assets/scss/pageinfo";
29+
30+
@if $td-enable-google-fonts {
31+
@import url($web-font-path);
32+
}
33+
34+
footer {
35+
min-height: 150px;
36+
37+
@include media-breakpoint-down(md) {
38+
min-height: 200px;
39+
}
40+
}
41+
42+
// Adjust anchors vs the fixed menu.
43+
@include media-breakpoint-up(md) {
44+
.td-offset-anchor:target {
45+
display: block;
46+
position: relative;
47+
top: -4rem;
48+
visibility: hidden;
49+
}
50+
51+
h2[id]:before, h3[id]:before, h4[id]:before, h5[id]:before {
52+
display: block;
53+
content: " ";
54+
margin-top: -5rem;
55+
height: 5rem;
56+
visibility: hidden;
57+
}
58+
}
59+
60+
61+
162
@import "functions";
263
@import "variables";
364
@import "reset";

content/en/docs/getting-started/_index.md

Lines changed: 10 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -17,17 +17,16 @@ These pages are under construction. TODO: Check Prerequisites and update
1717

1818
- [git](https://git-scm.com/downloads)
1919
- [go](https://golang.org/dl/) version `v1.12+`.
20-
- [docker](https://docs.docker.com/install/) version `17.03`+.
21-
- Alternatively [podman](https://github.com/containers/libpod/blob/master/install.md) `v1.2.0+` or [buildah](https://github.com/containers/buildah/blob/master/install.md) `v1.7+`
20+
- [docker](https://docs.docker.com/install/) version `17.03`+ or [podman](https://github.com/containers/libpod/blob/master/install.md) `v1.2.0+` or [buildah](https://github.com/containers/buildah/blob/master/install.md) `v1.7+`.
2221
- [kubectl](https://kubernetes.io/docs/tasks/tools/install-kubectl/) `v1.11.3+`.
2322
- Access to a Kubernetes `v1.11.3+` cluster.
2423

2524
## Installing OLM in your cluster
2625

2726
### Install Released OLM
28-
For installing release versions of OLM, for example version 0.12.0, you can use the following command:
27+
For installing release versions of OLM, for example version 0.15.1, you can use the following command:
2928

30-
```bash
29+
```sh
3130
export olm_release=0.15.1
3231
kubectl apply -f https://github.com/operator-framework/operator-lifecycle-manager/releases/download/${olm_release}/crds.yaml
3332
kubectl apply -f https://github.com/operator-framework/operator-lifecycle-manager/releases/download/${olm_release}/olm.yaml
@@ -38,7 +37,7 @@ Learn more about available releases [here](https://github.com/operator-framework
3837

3938
To deploy OLM locally on a [minikube cluster](https://kubernetes.io/docs/tasks/tools/install-minikube/) for development work, use the `run-local` target in the [Makefile](https://github.com/operator-framework/operator-lifecycle-manager/blob/master/Makefile).
4039

41-
```bash
40+
```sh
4241
git clone https://github.com/operator-framework/operator-lifecycle-manager.git
4342
cd operator-lifecycle-manager
4443
make run-local
@@ -48,7 +47,7 @@ make run-local
4847

4948
You can verify your installation of OLM by first checking for all the neccesasary CRDs in the cluster:
5049

51-
```bash
50+
```sh
5251
$ kubectl get crd
5352
NAME CREATED AT
5453
catalogsources.operators.coreos.com 2019-10-21T18:15:27Z
@@ -60,7 +59,7 @@ subscriptions.operators.coreos.com 2019-10-21T18:15:27Z
6059

6160
And then inspecting the deployments of OLM and it's related components:
6261

63-
```bash
62+
```sh
6463
$ kubectl get deploy -n olm
6564
NAME READY UP-TO-DATE AVAILABLE AGE
6665
catalog-operator 1/1 1 1 5m52s
@@ -73,7 +72,7 @@ packageserver 2/2 2 2 5m43s
7372
When you install OLM, it comes packaged with a number of Operators developed by the community that you can install instantly.
7473
You can use the `pacakagemanifest` api to see the operators available for you to install in your cluster:
7574

76-
```bash
75+
```sh
7776
$ kubectl get packagemanifest -n olm
7877
NAME CATALOG AGE
7978
cassandra-operator Community Operators 26m
@@ -85,7 +84,7 @@ wildfly Community Operators 26m
8584

8685
To install the etcd operator in the default namespace, first create an `OperatorGroup` for the default namespace:
8786

88-
```bash
87+
```sh
8988
$ cat operatorgroup.yaml
9089
kind: OperatorGroup
9190
apiVersion: operators.coreos.com/v1
@@ -102,7 +101,7 @@ operatorgroup.operators.coreos.com/og-single created
102101

103102
Then create a subscription for the etcd operator:
104103

105-
```bash
104+
```sh
106105
$ cat subscription.yaml
107106
apiVersion: operators.coreos.com/v1alpha1
108107
kind: Subscription
@@ -123,7 +122,7 @@ subscription.operators.coreos.com/etcd created
123122

124123
This installs the v0.9.2 version of the etcd operator, and then upgrades to the latest version of the etcd operator in your cluster.
125124

126-
```bash
125+
```sh
127126
$ kubectl get sub -n default
128127
NAME PACKAGE SOURCE CHANNEL
129128
etcd etcd operatorhubio-catalog singlenamespace-alpha

layouts/docs/list.html

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
{{ define "main" }}
2+
<div class="td-content">
3+
<h1>{{ .Title }}</h1>
4+
{{ with .Params.description }}<div class="lead">{{ . | markdownify }}</div>{{ end }}
5+
{{ .Content }}
6+
{{ partial "section-index.html" . }}
7+
{{ if (and (not .Params.hide_feedback) (.Site.Params.ui.feedback.enable) (.Site.GoogleAnalytics)) }}
8+
{{ partial "feedback.html" .Site.Params.ui.feedback }}
9+
<br />
10+
{{ end }}
11+
{{ if (.Site.DisqusShortname) }}
12+
<br />
13+
{{ partial "disqus-comment.html" . }}
14+
{{ end }}
15+
<div class="text-muted mt-5 pt-3 border-top">{{ partial "page-meta-lastmod.html" . }}</div>
16+
</div>
17+
{{ end }}

layouts/docs/single.html

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
{{ define "main" }}
2+
{{ .Render "content" }}
3+
{{ end }}

layouts/partials/section-index.html

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
<div class="section-index">
2+
{{ $pages := (where .Site.Pages "Section" .Section).ByWeight }}
3+
{{ $parent := .Page }}
4+
{{ if $parent.Params.no_list }}
5+
{{/* If no_list is true we don't show a list of subpages */}}
6+
{{ else if $parent.Params.simple_list }}
7+
{{/* If simple_list is true we show a bulleted list of subpages */}}
8+
<ul>
9+
{{ range $pages }}
10+
{{ if eq .Parent $parent }}
11+
<li><a href="{{ .RelPermalink }}">{{- .Title -}}</a></li>
12+
{{ end }}
13+
{{ end }}
14+
</ul>
15+
{{ else }}
16+
{{/* Otherwise we show a nice formatted list of subpages with page descriptions */}}
17+
<hr class="panel-line">
18+
{{ range $pages }}
19+
{{ if eq .Parent $parent }}
20+
<div class="entry">
21+
<h3>
22+
<a href="{{ .RelPermalink }}">{{- .Title -}}</a>
23+
</h3>
24+
<p>{{ .Description | markdownify }}</p>
25+
</div>
26+
{{ end }}
27+
{{ end }}
28+
{{ end }}
29+
</div>

netlify.toml

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,3 @@
1-
21
[build]
32
command = "hugo --gc --minify -b $URL"
43
publish = "public"

themes/docsy/assets/scss/section-index.scss

Lines changed: 15 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,19 @@
1-
// .section-index {
1+
.section-index {
22

3-
// .entry {
4-
// padding: .75rem;
5-
// }
3+
.entry {
4+
padding: .75rem;
5+
}
66

7-
// h5 {
8-
// margin-bottom: 0;
7+
h5 {
8+
margin-bottom: 0;
99

10-
// a {
11-
// font-weight: 700;
12-
// }
13-
// }
10+
a {
11+
font-weight: 700;
12+
}
13+
}
14+
15+
p {
16+
margin-top: 0;
17+
}
18+
}
1419

15-
// p {
16-
// margin-top: 0;
17-
// }
18-
// }

themes/docsy/assets/vendor/bootstrap/dist/css/bootstrap-reboot.css

Lines changed: 1 addition & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

themes/docsy/assets/vendor/bootstrap/scss/bootstrap.scss

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@
99
@import "variables";
1010
@import "mixins";
1111
@import "root";
12-
// @import "reboot";
12+
@import "reboot";
1313
@import "type";
1414
@import "images";
1515
@import "code";

0 commit comments

Comments
 (0)