Skip to content

Commit 7a8e535

Browse files
authored
Update getting started guide for 25.10 and srl image for greeter app (#203)
* update srl image for greeter app * fix make phony statement * singular -> plural * update getting started guide
1 parent 2cb9a6f commit 7a8e535

File tree

6 files changed

+97
-105
lines changed

6 files changed

+97
-105
lines changed

.github/workflows/cicd.yml

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -9,11 +9,11 @@ on:
99
pull_request:
1010

1111
env:
12-
MKDOCS_MATERIAL_VER: 9.6.16-insiders-4.53.16-hellt
12+
MKDOCS_MATERIAL_IMAGE: ghcr.io/eda-labs/mkdocs-material:v9.7.1-1
1313

1414
jobs:
1515
docs-test:
16-
runs-on: ubuntu-22.04
16+
runs-on: ubuntu-24.04
1717
steps:
1818
- uses: actions/checkout@v4
1919

@@ -24,7 +24,7 @@ jobs:
2424
username: ${{ github.actor }}
2525
password: ${{ secrets.GITHUB_TOKEN }}
2626

27-
- run: docker run -v $(pwd):/docs --entrypoint mkdocs ghcr.io/srl-labs/mkdocs-material-insiders:$MKDOCS_MATERIAL_VER build --clean --strict
27+
- run: docker run -v $(pwd):/docs --entrypoint mkdocs ${MKDOCS_MATERIAL_IMAGE} build --clean --strict
2828

2929
- name: Cache htmltest external links
3030
id: cache-htmltest
@@ -71,7 +71,7 @@ jobs:
7171
# - run: docker run -v $(pwd):/docs --entrypoint ash ghcr.io/srl-labs/mkdocs-material-insiders:$MKDOCS_MATERIAL_VER -c 'git config --global --add safe.directory /docs; mkdocs gh-deploy --force'
7272

7373
publish-docs:
74-
runs-on: ubuntu-22.04
74+
runs-on: ubuntu-24.04
7575
env:
7676
BRANCH_NAME: ${{ github.head_ref || github.ref_name }}
7777
steps:
@@ -89,7 +89,7 @@ jobs:
8989

9090
- name: Build docs
9191
run: |
92-
docker run --env CI=true --env MKDOCS_GIT_COMMITTERS_APIKEY=${{ secrets.GITHUB_TOKEN }} -v $(pwd):/docs --user $(id -u):$(id -g) --entrypoint mkdocs ghcr.io/srl-labs/mkdocs-material-insiders:$MKDOCS_MATERIAL_VER build
92+
docker run --env CI=true --env MKDOCS_GIT_COMMITTERS_APIKEY=${{ secrets.GITHUB_TOKEN }} -v $(pwd):/docs --user $(id -u):$(id -g) --entrypoint mkdocs ${MKDOCS_MATERIAL_IMAGE} build
9393
9494
- name: Publish to Cloudflare Pages
9595
uses: cloudflare/wrangler-action@v3

Makefile

Lines changed: 13 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -1,43 +1,33 @@
1-
MKDOCS_VER = 9.6.1
2-
# insiders version/tag https://github.com/srl-labs/mkdocs-material-insiders/pkgs/container/mkdocs-material-insiders
3-
# when changing the version, update the version in the cicd.yml file
4-
MKDOCS_INS_VER = 9.6.16-insiders-4.53.16-hellt
1+
MKDOCS_VERSION ?= v9.7.1-1
2+
MKDOCS_INET_IMAGE := ghcr.io/eda-labs/mkdocs-material:$(MKDOCS_VERSION)
53

64
.PHONY: docs
75
docs:
8-
docker run --rm -v $$(pwd):/docs --entrypoint mkdocs registry.srlinux.dev/pub/mkdocs-material-insiders:$(MKDOCS_INS_VER) build --clean --strict
6+
docker run --rm -v $$(pwd):/docs --entrypoint mkdocs ${MKDOCS_INET_IMAGE} build --clean --strict
97

10-
# serve the site locally using mkdocs-material public container
11-
.PHONY: serve
12-
serve:
13-
docker run -it --rm -p 8001:8000 -v $$(pwd):/docs squidfunk/mkdocs-material:$(MKDOCS_VER)
14-
15-
# serve the site locally using mkdocs-material insiders container
16-
.PHONY: serve-insiders
17-
serve-insiders:
8+
# serve the doc site locally with full site rendered on each change (slower)
9+
.PHONY: serve-docs-full
10+
serve-docs-full:
1811
docker run -it --rm -p 8001:8000 -v $$(pwd):/docs registry.srlinux.dev/pub/mkdocs-material-insiders:$(MKDOCS_INS_VER)
1912

20-
# serve the site locally using mkdocs-material insiders container using dirty-reloader
21-
.PHONY: serve-insiders-dirty
22-
serve-insiders-dirty:
23-
docker run -it --rm -p 8001:8000 -v $$(pwd):/docs registry.srlinux.dev/pub/mkdocs-material-insiders:$(MKDOCS_INS_VER) serve --dirtyreload -a 0.0.0.0:8000
24-
13+
# serve the doc site locally with dirty reload (faster, but toc updates may require a manual stop/start)
2514
.PHONY: serve-docs
26-
serve-docs: serve-insiders-dirty
15+
serve-docs:
16+
docker run -it --rm -p 8001:8000 -v $$(pwd):/docs ${MKDOCS_INET_IMAGE} serve --dirtyreload -a 0.0.0.0:8000
2717

2818
.PHONY: htmltest
2919
htmltest:
30-
docker run --rm -v $$(pwd):/docs --entrypoint mkdocs registry.srlinux.dev/pub/mkdocs-material-insiders:$(MKDOCS_INS_VER) build --clean --strict
20+
docker run --rm -v $$(pwd):/docs --entrypoint mkdocs ${MKDOCS_INET_IMAGE} build --clean --strict
3121
docker run --rm -v $$(pwd):/test wjdp/htmltest --conf ./site/htmltest.yml
3222
rm -rf ./site
3323

3424
build-insiders:
35-
docker run -v $$(pwd):/docs --entrypoint mkdocs registry.srlinux.dev/pub/mkdocs-material-insiders:$(MKDOCS_INS_VER) build --clean --strict
25+
docker run -v $$(pwd):/docs --entrypoint mkdocs ${MKDOCS_INET_IMAGE} build --clean --strict
3626

3727
push-docs: # push docs to gh-pages branch manually. Use when pipeline misbehaves
38-
docker run -v ${SSH_AUTH_SOCK}:/ssh-agent --env SSH_AUTH_SOCK=/ssh-agent --env GIT_SSH_COMMAND="ssh -o UserKnownHostsFile=/dev/null -o StrictHostKeyChecking=no" -v $$(pwd):/docs --entrypoint mkdocs ghcr.io/srl-labs/mkdocs-material-insiders:$(MKDOCS_INS_VER) gh-deploy --force --strict
28+
docker run -v ${SSH_AUTH_SOCK}:/ssh-agent --env SSH_AUTH_SOCK=/ssh-agent --env GIT_SSH_COMMAND="ssh -o UserKnownHostsFile=/dev/null -o StrictHostKeyChecking=no" -v $$(pwd):/docs --entrypoint mkdocs ${MKDOCS_INET_IMAGE} gh-deploy --force --strict
3929

40-
add-no-index: # replace noindex commen in main template to include robots noindex instruction. This is needed prior pushing to staging, so that staging is not indexed by robots
30+
add-no-index: # replace noindex comment in main template to include robots noindex instruction. This is needed prior pushing to staging, so that staging is not indexed by robots
4131
sed -i 's/<!-- NOINDEX -->/<meta name="robots" content="noindex">/g' docs/overrides/main.html
4232

4333
# build html docs and push to staging1 server - https://hellt.github.io/learn-srlinux-stage1

0 commit comments

Comments
 (0)