Skip to content

Commit

Permalink
Merge branch 'master' into mep-4-updates
Browse files Browse the repository at this point in the history
  • Loading branch information
Gerrit91 committed Mar 21, 2024
2 parents dc2cf09 + 62b7704 commit 0380a53
Show file tree
Hide file tree
Showing 222 changed files with 9,915 additions and 3,955 deletions.
2 changes: 2 additions & 0 deletions .gitconfig
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
[safe]
directory = /workdir
2 changes: 1 addition & 1 deletion .github/workflows/auto_generate.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ jobs:
build:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v2
- uses: actions/checkout@v4
with:
submodules: "true"
lfs: true
Expand Down
4 changes: 2 additions & 2 deletions .github/workflows/deploy.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -11,13 +11,13 @@ jobs:
build:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v2
- uses: actions/checkout@v4
with:
submodules: "true"
lfs: true
- uses: julia-actions/setup-julia@latest
with:
version: 1.6.1
version: 1.9.4
- name: Install dependencies
run: julia --color=yes --project=docs/ -e 'using Pkg; Pkg.develop(PackageSpec(path=pwd()))'
- name: Build and deploy
Expand Down
4 changes: 2 additions & 2 deletions .github/workflows/release.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -10,13 +10,13 @@ jobs:
build:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v2
- uses: actions/checkout@v4
with:
submodules: "true"
lfs: true
- uses: julia-actions/setup-julia@latest
with:
version: 1.6.1
version: 1.9.4
- name: Install dependencies
run: julia --color=yes --project=docs/ -e 'using Pkg; Pkg.develop(PackageSpec(path=pwd()))'
- name: Build and deploy
Expand Down
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,2 +1,3 @@
.idea
docs/build
*.pdf
6 changes: 6 additions & 0 deletions .vscode/settings.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
{
"markdown.marp.themes": [
"marp/themes/metal-stack.css"
],
"markdown.marp.enableHtml": true
}
2 changes: 1 addition & 1 deletion Dockerfile
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
FROM julia:1.6.1
FROM julia:1.9.4
WORKDIR /workdir
COPY Project.toml Project.toml
COPY docs/Project.toml docs/Project.toml
Expand Down
2 changes: 1 addition & 1 deletion Dockerfile.updater
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
FROM ubuntu:20.04
FROM ubuntu:22.04
RUN apt update \
&& apt install -y git curl \
&& curl -Lo /usr/local/bin/yq https://github.com/mikefarah/yq/releases/download/v4.9.3/yq_linux_amd64 \
Expand Down
5 changes: 3 additions & 2 deletions Makefile
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
.DEFAULT_GOAL := build
RELEASE_VERSION := $(or ${RELEASE_VERSION},"v0.7.2")
RELEASE_VERSION := $(or ${RELEASE_VERSION},"v0.17.4")

ifeq ($(CI),true)
DOCKER_TTY_ARG=
Expand All @@ -11,7 +11,8 @@ endif
build:
docker build -t docs-builder .
docker run -i$(DOCKER_TTY_ARG) --rm \
-v $(PWD)/docs:/workdir/docs \
-v $(PWD):/workdir \
-v $(PWD)/.gitconfig:/root/.gitconfig \
-e RELEASE_VERSION=$(RELEASE_VERSION) \
-w /workdir \
docs-builder julia \
Expand Down
8 changes: 4 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# Docs

[![](https://img.shields.io/badge/docs-stable-blue.svg)](https://docs.metal-stack.io/)
[![](https://img.shields.io/badge/docs-dev-blue.svg)](https://docs.metal-stack.io/dev/)
[![Stable Docs](https://img.shields.io/badge/docs-stable-blue.svg)](https://docs.metal-stack.io/)
[![Devel Docs](https://img.shields.io/badge/docs-dev-blue.svg)](https://docs.metal-stack.io/dev/)

This repository contains the documentation of metal-stack at [docs.metal-stack.io](https://docs.metal-stack.io/).

Expand All @@ -11,15 +11,15 @@ It is being generated using [Julia Documenter](https://github.com/JuliaDocs/Docu

To generate the documentation you can use the following command (only Docker is required):

```
```bash
make
```

The result is being written to `docs/build` and is fully static. You can simply view it in your browser by opening `docs/build/index.html`.

To update the docs that is included from external repositories (e.g. metalctl, mini-lab, ...), you can run the following target:

```
```make
RELEASE_VERSION=master make update
```

Expand Down
Loading

0 comments on commit 0380a53

Please sign in to comment.