Skip to content

Commit 602752a

Browse files
committed
render custom tags in doc site
1 parent 2c4794d commit 602752a

File tree

5 files changed

+34
-1
lines changed

5 files changed

+34
-1
lines changed

docs/css/extra.css

Lines changed: 16 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,4 +7,19 @@
77
.md-nav__item--active > .md-nav__link, /* Active top-level items */
88
.md-nav__item--nested > .md-nav__link { /* Nested top-level items */
99
font-weight: bold;
10-
}
10+
}
11+
12+
.tags-list {
13+
list-style: none;
14+
padding: 0;
15+
}
16+
17+
.tag {
18+
display: inline-block;
19+
background-color: red;
20+
border-radius: 3px;
21+
padding: 2px 8px;
22+
margin: 2px;
23+
font-size: 0.9em;
24+
color: white;
25+
}

docs/howto/configure-global-pull-secrets.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,8 @@ tags:
55

66
# Configure global pull secrets for allowing components to pull private images
77

8+
**Note: The UX for how auth info for using private images is provided is an active work in progress.**
9+
810
To configure `catalogd` and `operator-controller` to use authentication information for pulling private images (catalog/bundle images etc), the components can be informed about a kubernetes `Secret` object that contains the relevant auth information. The `Secret` must be of type `kubernetes.io/dockerconfigjson`.
911

1012
Once the `Secret` is created, `catalogd` and `operator-controller` needs to be redeployed with an additional field, `--global-pull-secret=<secret-namespace>/<secret-name>` passed to the respective binaries.

docs/overrides/main.html

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
{% extends "base.html" %}
2+
3+
{% block content %}
4+
<div class="tags">
5+
{% if page.meta.tags %}
6+
<ul class="tags-list">
7+
{% for tag in page.meta.tags %}
8+
<li class="tag">{{ tag }}</li>
9+
{% endfor %}
10+
</ul>
11+
{% endif %}
12+
</div>
13+
{{ super() }}
14+
{% endblock %}

mkdocs.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,7 @@ site_name: Operator Lifecycle Manager
44
theme:
55
logo: assets/logo.svg
66
name: "material"
7+
custom_dir: docs/overrides
78
palette:
89
primary: black
910
features:

requirements.txt

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -33,3 +33,4 @@ six==1.16.0
3333
soupsieve==2.6
3434
urllib3==2.2.3
3535
watchdog==4.0.2
36+

0 commit comments

Comments
 (0)