Skip to content

Commit

Permalink
render custom tags in doc site
Browse files Browse the repository at this point in the history
  • Loading branch information
anik120 committed Oct 29, 2024
1 parent 2c4794d commit 602752a
Show file tree
Hide file tree
Showing 5 changed files with 34 additions and 1 deletion.
17 changes: 16 additions & 1 deletion docs/css/extra.css
Original file line number Diff line number Diff line change
Expand Up @@ -7,4 +7,19 @@
.md-nav__item--active > .md-nav__link, /* Active top-level items */
.md-nav__item--nested > .md-nav__link { /* Nested top-level items */
font-weight: bold;
}
}

.tags-list {
list-style: none;
padding: 0;
}

.tag {
display: inline-block;
background-color: red;
border-radius: 3px;
padding: 2px 8px;
margin: 2px;
font-size: 0.9em;
color: white;
}
2 changes: 2 additions & 0 deletions docs/howto/configure-global-pull-secrets.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,8 @@ tags:

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

**Note: The UX for how auth info for using private images is provided is an active work in progress.**

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`.

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.
Expand Down
14 changes: 14 additions & 0 deletions docs/overrides/main.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
{% extends "base.html" %}

{% block content %}
<div class="tags">
{% if page.meta.tags %}
<ul class="tags-list">
{% for tag in page.meta.tags %}
<li class="tag">{{ tag }}</li>
{% endfor %}
</ul>
{% endif %}
</div>
{{ super() }}
{% endblock %}
1 change: 1 addition & 0 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ site_name: Operator Lifecycle Manager
theme:
logo: assets/logo.svg
name: "material"
custom_dir: docs/overrides
palette:
primary: black
features:
Expand Down
1 change: 1 addition & 0 deletions requirements.txt
Original file line number Diff line number Diff line change
Expand Up @@ -33,3 +33,4 @@ six==1.16.0
soupsieve==2.6
urllib3==2.2.3
watchdog==4.0.2

0 comments on commit 602752a

Please sign in to comment.