Skip to content

Commit cac7f40

Browse files
dschmidtdragotin
authored andcommitted
Update docs setup to the reworked docs action
Move opencloud-service.yml to the repo root, add a docs/intro.md overview overlay, and point the workflow and dev/build-docs.sh at the action's new .cache/service-docs layout (action @8956447).
1 parent e3cf9ea commit cac7f40

7 files changed

Lines changed: 38 additions & 35 deletions

File tree

‎.github/docs/opencloud-service.yml‎

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

‎.github/workflows/docs.yml‎

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -31,9 +31,8 @@ jobs:
3131
cache: false
3232

3333
- id: build
34-
uses: dschmidt/opencloud-service-docs-action@6dad19b92b7bdb0351dd637bc49ead2c5b269cfc
34+
uses: dschmidt/opencloud-service-docs-action@8956447c5724ba20479b5dea49156d4f5db82116
3535

36-
# PR dry-run: downloadable site preview, never published.
3736
- name: Upload PR preview artifact
3837
if: github.event_name == 'pull_request'
3938
uses: actions/upload-artifact@v4
@@ -42,7 +41,6 @@ jobs:
4241
path: ${{ steps.build.outputs.site-path }}
4342
retention-days: 14
4443

45-
# Pages-bound artifact for main / manual deploys.
4644
- name: Upload Pages artifact
4745
if: github.ref == 'refs/heads/main' || inputs.deploy
4846
uses: actions/upload-pages-artifact@v3

‎.gitignore‎

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,4 @@
11
.env
22

3-
# Docs build (generated by `make docs`; the site is built + deployed in CI)
4-
.github/docs/.cache/
5-
.github/docs/docs/
6-
docs/generated/
3+
# Docs build cache (regenerated by `make docs`).
4+
/.cache/

‎Makefile‎

Lines changed: 3 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -13,15 +13,11 @@ vet:
1313
go vet ./...
1414

1515
# --- Docs ---
16-
# Service reference site (env vars, example config, deprecations).
17-
# Runs dschmidt/opencloud-service-docs-action at the SHA pinned in
18-
# .github/workflows/docs.yml — identical code path to CI.
19-
2016
docs:
21-
DOCS_OUTPUT="$(CURDIR)/docs/generated" bash .github/docs/run.sh
17+
bash dev/build-docs.sh
2218

2319
docs-serve-prod:
24-
cd .github/docs/.cache/site && pnpm run serve
20+
cd .cache/service-docs/site && pnpm run serve
2521

2622
docs-clean:
27-
rm -rf .github/docs/.cache docs/generated
23+
rm -rf .cache/service-docs
Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,10 +7,10 @@
77
set -euo pipefail
88

99
SCRIPT_DIR="$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)"
10-
REPO_ROOT="$(cd "$SCRIPT_DIR/.." && cd .. && pwd)"
10+
REPO_ROOT="$(cd "$SCRIPT_DIR/.." && pwd)"
1111
WORKFLOW="$REPO_ROOT/.github/workflows/docs.yml"
1212
ACTION_REPO="dschmidt/opencloud-service-docs-action"
13-
ACTION_DIR="$SCRIPT_DIR/.cache/action"
13+
ACTION_DIR="$REPO_ROOT/.cache/service-docs/action"
1414

1515
REF="$(grep -oE "${ACTION_REPO}@[^ \"']+" "$WORKFLOW" | head -1 | cut -d@ -f2)"
1616
[ -n "$REF" ] || { echo "error: could not find ${ACTION_REPO}@<ref> in $WORKFLOW" >&2; exit 1; }

‎docs/intro.md‎

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
---
2+
sidebar_position: 1
3+
slug: /
4+
title: Overview
5+
---
6+
7+
# immichframe-opencloud service reference
8+
9+
immichframe-opencloud serves the [ImmichFrame](https://github.com/immichFrame/ImmichFrame)
10+
HTTP API from an [OpenCloud](https://opencloud.eu) space instead of an Immich
11+
server. It reads photos from the space over the LibreGraph (listing) and WebDAV
12+
(content) APIs, so the ImmichFrame web UI and clients work unchanged.
13+
14+
- **[Environment variables](configuration/environment-variables)** — every env var parsed by the service at startup.
15+
- **[Example configuration](configuration/example-config)** — YAML config with all defaults.
16+
- **[Deprecations](configuration/deprecations)** — renamed or removed env vars.
17+
18+
For installation and operational docs see the
19+
[GitHub repository](https://github.com/dragotin/immichframe-opencloud#readme).

‎opencloud-service.yml‎

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
# Consumed by dschmidt/opencloud-service-docs-action.
2+
service:
3+
name: immichframe
4+
5+
site:
6+
title: immichframe-opencloud
7+
tagline: ImmichFrame API backed by an OpenCloud space
8+
9+
pins:
10+
generator_ref: 80a5711c890de7720f53e585a32cb8be47b27709
11+
theme_ref: 0909f2d83e91f107a770ae5da3b8d3127279c26c

0 commit comments

Comments
 (0)