generated from sig_core/wiki-template
update template, add dev container
This commit is contained in:
parent
fcb1b46e82
commit
eec21c5e02
6
.github/workflows/build.yml
vendored
6
.github/workflows/build.yml
vendored
@ -11,7 +11,7 @@ jobs:
|
|||||||
image: docker.io/rockylinux:9
|
image: docker.io/rockylinux:9
|
||||||
steps:
|
steps:
|
||||||
- name: Install deps
|
- name: Install deps
|
||||||
run: dnf -y install git python3 python3-pip
|
run: dnf -y install git python3 python3-pip cairo-devel
|
||||||
|
|
||||||
- name: setup ssh
|
- name: setup ssh
|
||||||
env:
|
env:
|
||||||
@ -30,9 +30,9 @@ jobs:
|
|||||||
|
|
||||||
- name: Install python requirements
|
- name: Install python requirements
|
||||||
run: python3 -m pip install -r requirements.txt
|
run: python3 -m pip install -r requirements.txt
|
||||||
|
|
||||||
- name: Deploy
|
- name: Deploy
|
||||||
env:
|
env:
|
||||||
GIT_SSH_COMMAND: "ssh -o UserKnownHostsFile=/dev/null -o StrictHostKeyChecking=no"
|
GIT_SSH_COMMAND: "ssh -o UserKnownHostsFile=/dev/null -o StrictHostKeyChecking=no"
|
||||||
GIT_AUTHOR_NAME: "Rocky Bot"
|
GIT_AUTHOR_NAME: "Rocky Bot"
|
||||||
GIT_AUTHOR_EMAIL: "auto@rockylinux.org"
|
GIT_AUTHOR_EMAIL: "auto@rockylinux.org"
|
||||||
|
1
.gitignore
vendored
Normal file
1
.gitignore
vendored
Normal file
@ -0,0 +1 @@
|
|||||||
|
site/
|
8
Containerfile
Normal file
8
Containerfile
Normal file
@ -0,0 +1,8 @@
|
|||||||
|
FROM quay.io/rockylinux/rockylinux:9
|
||||||
|
|
||||||
|
RUN dnf -y upgrade
|
||||||
|
RUN dnf install -y git python3 python3-pip cairo-devel
|
||||||
|
|
||||||
|
COPY . /wiki
|
||||||
|
WORKDIR /wiki
|
||||||
|
RUN pip install -r requirements.txt
|
26
README.md
26
README.md
@ -5,3 +5,29 @@
|
|||||||
## Continuous Integration / Continuous Deployment
|
## Continuous Integration / Continuous Deployment
|
||||||
|
|
||||||
Actions Runner executes workflow to publish to https://REPLACEME.rocky.page on push to main.
|
Actions Runner executes workflow to publish to https://REPLACEME.rocky.page on push to main.
|
||||||
|
|
||||||
|
## Building Locally
|
||||||
|
|
||||||
|
In order to build this wiki locally, a docker-compose configuration and container file are supplied which when invoked, will launch mkdocs' development server in a container bound to port 8000 and will live-reload when changes are made to the wiki files.
|
||||||
|
|
||||||
|
To run the containers on your system, invoke podman or docker compose like so:
|
||||||
|
|
||||||
|
```
|
||||||
|
podman-compose -f docker-compose.yml up -d
|
||||||
|
```
|
||||||
|
|
||||||
|
The container will build and then launch itself. Afterwards, you should be able to view the wiki content at http://localhost:8000.
|
||||||
|
|
||||||
|
The compose file accepts a build argument if you need to run it on a different port. For example, to bind to port 8080 on your local machine:
|
||||||
|
|
||||||
|
```
|
||||||
|
podman-compose -f docker-compose --build-arg PORT=8080 up -d
|
||||||
|
```
|
||||||
|
|
||||||
|
## Project layout
|
||||||
|
|
||||||
|
mkdocs.yml # The configuration file.
|
||||||
|
README.md # This file.
|
||||||
|
docs/
|
||||||
|
index.md # The documentation homepage.
|
||||||
|
... # Other markdown pages, images and other files.
|
||||||
|
13
docker-compose.yml
Normal file
13
docker-compose.yml
Normal file
@ -0,0 +1,13 @@
|
|||||||
|
---
|
||||||
|
version: '3'
|
||||||
|
|
||||||
|
services:
|
||||||
|
wiki:
|
||||||
|
build:
|
||||||
|
context: .
|
||||||
|
dockerfile: Containerfile
|
||||||
|
command: ["mkdocs", "serve","--dev-addr", "0.0.0.0:${PORT:-8000}"]
|
||||||
|
volumes:
|
||||||
|
- .:/wiki:z,rw
|
||||||
|
ports:
|
||||||
|
- "${PORT:-8000}:8000"
|
@ -8,9 +8,3 @@
|
|||||||
|
|
||||||
## Members
|
## Members
|
||||||
|
|
||||||
## Project layout
|
|
||||||
|
|
||||||
mkdocs.yml # The configuration file.
|
|
||||||
docs/
|
|
||||||
index.md # The documentation homepage.
|
|
||||||
... # Other markdown pages, images and other files.
|
|
||||||
|
@ -11,7 +11,7 @@ repo_name: REPLACEME/wiki
|
|||||||
edit_uri: _edit/main/docs/
|
edit_uri: _edit/main/docs/
|
||||||
|
|
||||||
# Copyright
|
# Copyright
|
||||||
copyright: Copyright © 2023 Rocky Enterprise Software Foundation
|
copyright: Copyright © 2024 Rocky Enterprise Software Foundation
|
||||||
|
|
||||||
# Configuration
|
# Configuration
|
||||||
theme:
|
theme:
|
||||||
@ -69,8 +69,8 @@ markdown_extensions:
|
|||||||
- meta
|
- meta
|
||||||
- pymdownx.details # this allows collapsible attributions
|
- pymdownx.details # this allows collapsible attributions
|
||||||
- pymdownx.emoji:
|
- pymdownx.emoji:
|
||||||
emoji_index: !!python/name:materialx.emoji.twemoji
|
emoji_index: !!python/name:material.extensions.emoji.twemoji
|
||||||
emoji_generator: !!python/name:materialx.emoji.to_svg
|
emoji_generator: !!python/name:material.extensions.emoji.to_svg
|
||||||
- pymdownx.superfences
|
- pymdownx.superfences
|
||||||
- pymdownx.tabbed:
|
- pymdownx.tabbed:
|
||||||
alternate_style: true
|
alternate_style: true
|
||||||
|
@ -5,3 +5,4 @@ mkdocs-git-revision-date-localized-plugin
|
|||||||
mkdocs-macros-plugin
|
mkdocs-macros-plugin
|
||||||
mkdocs-material
|
mkdocs-material
|
||||||
mkdocs-windmill
|
mkdocs-windmill
|
||||||
|
mkdocs-material[imaging]
|
||||||
|
Loading…
Reference in New Issue
Block a user