Skip to content

Commit f0c3b61

Browse files
karl-johan-grahnkarl-johan-grahn
authoredApr 26, 2024··
Docs restructuring (#644)
* update * update * update
·
v1.4.0merge-758
1 parent 7cde0e7 commit f0c3b61

14 files changed

+136
-15
lines changed
 

‎.github/workflows/pull_request.yaml

-6
Original file line numberDiff line numberDiff line change
@@ -13,12 +13,6 @@ env:
1313
REGISTRY: ghcr.io
1414

1515
jobs:
16-
qa:
17-
uses: stakater/.github/.github/workflows/pull_request_doc_qa.yaml@v0.0.71
18-
with:
19-
MD_CONFIG: .github/md_config.json
20-
DOC_SRC: README.md docs
21-
MD_LINT_CONFIG: .markdownlint.yaml
2216
build:
2317
runs-on: ubuntu-latest
2418
name: Build

‎.github/workflows/pull_request_docs.yaml

+26
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
name: Pull Request for Documentation Changes
2+
3+
on:
4+
pull_request_target:
5+
branches:
6+
- master
7+
paths:
8+
- 'README.md'
9+
- 'docs/**'
10+
11+
jobs:
12+
qa:
13+
uses: stakater/.github/.github/workflows/pull_request_doc_qa.yaml@v0.0.71
14+
with:
15+
MD_CONFIG: .github/md_config.json
16+
DOC_SRC: README.md docs
17+
MD_LINT_CONFIG: .markdownlint.yaml
18+
build:
19+
uses: stakater/.github/.github/workflows/pull_request_container_build.yaml@v0.0.71
20+
with:
21+
DOCKER_FILE_PATH: Dockerfile-docs
22+
secrets:
23+
CONTAINER_REGISTRY_URL: ghcr.io/stakater/docs
24+
CONTAINER_REGISTRY_USERNAME: stakater-user
25+
CONTAINER_REGISTRY_PASSWORD: ${{ secrets.STAKATER_GITHUB_TOKEN }}
26+
SLACK_WEBHOOK_URL: ${{ secrets.STAKATER_DELIVERY_SLACK_WEBHOOK }}

‎.github/workflows/push_docs.yaml

+22
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
name: Push Documentation Changes
2+
3+
on:
4+
push:
5+
branches:
6+
- master
7+
paths:
8+
- 'README.md'
9+
- 'docs/**'
10+
11+
jobs:
12+
push:
13+
uses: stakater/.github/.github/workflows/push_container.yaml@v0.0.71
14+
with:
15+
DOCKER_FILE_PATH: Dockerfile-docs
16+
RELEASE_BRANCH: master
17+
secrets:
18+
CONTAINER_REGISTRY_URL: ghcr.io/stakater/docs
19+
CONTAINER_REGISTRY_USERNAME: stakater-user
20+
CONTAINER_REGISTRY_PASSWORD: ${{ secrets.STAKATER_GITHUB_TOKEN }}
21+
SLACK_WEBHOOK_URL: ${{ secrets.STAKATER_DELIVERY_SLACK_WEBHOOK }}
22+
GH_TOKEN: ${{ secrets.STAKATER_GITHUB_TOKEN }}

‎.gitignore

+2
Original file line numberDiff line numberDiff line change
@@ -13,3 +13,5 @@ Reloader
1313
!**/chart/reloader
1414
*.tgz
1515
styles/
16+
site/
17+
/mkdocs.yml

‎.gitmodules

+3
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
[submodule "theme_common"]
2+
path = theme_common
3+
url = git@github.com:stakater/stakater-docs-mkdocs-theme.git

‎Dockerfile-docs

+35
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
FROM python:3.12 as builder
2+
3+
# set workdir
4+
RUN mkdir -p $HOME/application
5+
WORKDIR $HOME/application
6+
7+
# copy the entire application
8+
COPY --chown=1001:root . .
9+
10+
RUN pip3 install -r theme_common/requirements.txt
11+
12+
# Combine Theme Resources
13+
RUN python theme_common/scripts/combine_theme_resources.py theme_common/resources theme_override/resources dist/_theme
14+
# Produce mkdocs file
15+
RUN python theme_common/scripts/combine_mkdocs_config_yaml.py theme_common/mkdocs.yml theme_override/mkdocs.yml mkdocs.yml
16+
17+
# build the docs
18+
RUN mkdocs build
19+
20+
FROM nginxinc/nginx-unprivileged:1.25-alpine as deploy
21+
COPY --from=builder $HOME/application/site/ /usr/share/nginx/html/reloader/
22+
COPY docs-nginx.conf /etc/nginx/conf.d/default.conf
23+
24+
# set non-root user
25+
USER 1001
26+
27+
LABEL name="Stakater Reloader Documentation" \
28+
maintainer="Stakater <hello@stakater.com>" \
29+
vendor="Stakater" \
30+
release="1" \
31+
summary="Documentation for Stakater Reloader"
32+
33+
EXPOSE 8080:8080/tcp
34+
35+
CMD ["nginx", "-g", "daemon off;"]

‎docs-nginx.conf

+11
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
server {
2+
listen 8080;
3+
root /usr/share/nginx/html/;
4+
index index.html;
5+
error_page 403 404 /404.html;
6+
location = /404.html {
7+
internal;
8+
}
9+
# redirects issued by nginx will be relative
10+
absolute_redirect off;
11+
}

‎docs/How-it-works.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# How it works?
1+
# How does Reloader work?
22

33
Reloader watches for `ConfigMap` and `Secret` and detects if there are changes in data of these objects. After change detection Reloader performs rolling upgrade on relevant Pods via associated `Deployment`, `Daemonset` and `Statefulset`.
44

‎docs/features.md

-8
This file was deleted.

‎docs/index.md

+12
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
# Introduction
2+
3+
Reloader can watch changes in `ConfigMap` and `Secret` and do rolling upgrades on Pods with their associated `DeploymentConfigs`, `Deployments`, `Daemonsets` `Statefulsets` and `Rollouts`.
4+
5+
These are the key features of Reloader:
6+
7+
1. Restart pod in a `deployment` on change in linked/related configmap's or secret's
8+
1. Restart pod in a `daemonset` on change in linked/related configmap's or secret's
9+
1. Restart pod in a `statefulset` on change in linked/related configmap's or secret's
10+
1. Restart pod in a `rollout` on change in linked/related configmap's or secret's
11+
12+
This site contains more details on how Reloader works. For an overview, please see the repository's [README file](https://github.com/stakater/Reloader/blob/master/README.md).

‎theme_common

Submodule theme_common added at f63139f

‎theme_override/mkdocs.yml

+22
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
site_name: Stakater Reloader
2+
docs_dir: docs
3+
site_url: https://docs.stakater.com/reloader/
4+
repo_url: https://github.com/stakater/reloader
5+
edit_uri: blob/master/docs/
6+
7+
theme:
8+
favicon: assets/images/favicon.svg
9+
10+
nav:
11+
- index.md
12+
- How-to Guides:
13+
- Verify-Reloader-Working.md
14+
- Alerting.md
15+
- Reloader-with-Sealed-Secrets.md
16+
- Helm2-to-Helm3.md
17+
- References:
18+
- How-it-works.md
19+
- Container Build.md
20+
- Comparisons with similar tools:
21+
- Reloader-vs-ConfigmapController.md
22+
- Reloader-vs-k8s-trigger-controller.md

‎theme_override/resources/.gitignore

Whitespace-only changes.

‎theme_override/resources/assets/images/favicon.svg

+1
Loading

0 commit comments

Comments
 (0)
Please sign in to comment.