Skip to content
This repository was archived by the owner on Feb 11, 2026. It is now read-only.

Commit e4bbc12

Browse files
committed
fix: remove docker docs, use nix instead
1 parent 815ed63 commit e4bbc12

7 files changed

Lines changed: 62 additions & 103 deletions

File tree

.github/workflows/docs.yml

Lines changed: 45 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,45 @@
1+
name: Publish Documentation
2+
on:
3+
push:
4+
branches:
5+
- master
6+
7+
jobs:
8+
build:
9+
runs-on: ubuntu-latest
10+
permissions:
11+
contents: read
12+
pages: write
13+
id-token: write
14+
15+
environment:
16+
# environment created automatically by GitHub
17+
name: github-pages
18+
url: ${{ steps.deployment.outputs.page_url }}
19+
20+
steps:
21+
- name: Checkout repository
22+
uses: actions/checkout@v4
23+
24+
- name: Install Nix
25+
uses: cachix/install-nix-action@v27
26+
with:
27+
nix_path: nixpkgs=channel:nixos-unstable
28+
29+
- name: Build
30+
run: cd docs && nix-shell --run "mdbook build"
31+
32+
- name: Archive book
33+
uses: actions/upload-artifact@v4
34+
with:
35+
name: book
36+
path: docs/book/*
37+
38+
- name: Upload artifact
39+
uses: actions/upload-pages-artifact@v3
40+
with:
41+
path: "docs/book"
42+
43+
- name: Deploy to GitHub Pages
44+
id: deployment
45+
uses: actions/deploy-pages@v4

.github/workflows/publish.yml

Lines changed: 0 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -23,9 +23,6 @@ jobs:
2323
- context: ./nginx
2424
args: TEMPLATE_NAME=maps
2525
image: ghcr.io/ninanor/nina-catalogue-maps-proxy
26-
- context: ./docs
27-
image: ghcr.io/ninanor/nina-catalogue-docs
28-
target: prod
2926

3027
permissions:
3128
contents: read
@@ -60,31 +57,3 @@ jobs:
6057
push: true
6158
tags: ${{ steps.meta.outputs.tags }}
6259
labels: ${{ steps.meta.outputs.labels }}
63-
64-
publish_docs:
65-
if: github.ref == 'refs/heads/master'
66-
needs: build
67-
runs-on: ubuntu-latest
68-
container:
69-
image: ghcr.io/ninanor/nina-catalogue-docs:master
70-
credentials:
71-
username: ${{ github.actor }}
72-
password: ${{ secrets.GITHUB_TOKEN }}
73-
74-
permissions:
75-
pages: write
76-
id-token: write
77-
78-
environment:
79-
# environment created automatically by GitHub
80-
name: github-pages
81-
url: ${{ steps.deployment.outputs.page_url }}
82-
83-
steps:
84-
- name: Upload artifact
85-
uses: actions/upload-pages-artifact@v1
86-
with:
87-
path: "/var/www"
88-
- name: Deploy to GitHub Pages
89-
id: deployment
90-
uses: actions/deploy-pages@v2

docker-compose.yml

Lines changed: 0 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -117,32 +117,6 @@ services:
117117
ports:
118118
- 5432:5432
119119

120-
# documentation
121-
docs-dev:
122-
image: metadata_catalogue_docs
123-
build:
124-
context: ./docs
125-
dockerfile: ./Dockerfile
126-
target: dev
127-
volumes:
128-
- ./docs:/book
129-
ports:
130-
- "3001:3000"
131-
command: serve --hostname 0.0.0.0
132-
profiles:
133-
- dev
134-
135-
docs:
136-
image: metadata_catalogue_docs
137-
build:
138-
context: ./docs
139-
dockerfile: ./Dockerfile
140-
target: prod
141-
ports:
142-
- "3000:80"
143-
profiles:
144-
- prod
145-
146120
bruno:
147121
build:
148122
dockerfile: ./bruno/Dockerfile

docs/Dockerfile

Lines changed: 0 additions & 35 deletions
This file was deleted.

docs/README.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
# How to document
2+
3+
```
4+
nix-shell
5+
6+
mdbook serve
7+
mdbook build
8+
```

docs/default.conf.template

Lines changed: 0 additions & 11 deletions
This file was deleted.

docs/shell.nix

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
with import <nixpkgs> {
2+
};
3+
4+
let in pkgs.mkShell rec {
5+
buildInputs = [
6+
mdbook
7+
mdbook-kroki-preprocessor
8+
];
9+
}

0 commit comments

Comments
 (0)