From 6f6273ed19afdfa87e7ffa776bb7ddb4376c576e Mon Sep 17 00:00:00 2001 From: Skip Grube Date: Tue, 25 Apr 2023 12:24:50 -0400 Subject: [PATCH] Added contribution instructions - Brushed up README - Added container build files, similar to main Rocky Wiki -Skip G. --- Dockerfile | 15 +++++++++++++++ README.md | 23 ++++++++++++++++++++++- docker-compose.yml | 11 +++++++++++ 3 files changed, 48 insertions(+), 1 deletion(-) create mode 100644 Dockerfile create mode 100644 docker-compose.yml diff --git a/Dockerfile b/Dockerfile new file mode 100644 index 0000000..9cc71d2 --- /dev/null +++ b/Dockerfile @@ -0,0 +1,15 @@ +FROM rockylinux:9 + +RUN dnf update -y &&\ + dnf install -y git python3-pip &&\ + dnf clean all + +# bind volume $CWD > /wiki exists in docker-compose.yml +RUN mkdir /wiki +COPY requirements.txt /wiki +WORKDIR /wiki +RUN pip3 install -r requirements.txt + +EXPOSE 8000 +CMD mkdocs serve -a 0.0.0.0:8000 + diff --git a/README.md b/README.md index 38692e2..77927cb 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,27 @@ # SIG/AltArch Wiki -@TODO - fill in :) +This is a Wiki for the Rocky Linux Alternative Architectures SIG. It's an information repository that records the group efforts and findings. + +The AltArch special interest group looks at porting Rocky Linux to diverse or non-traditional platforms. Think small boards (Raspberry Pi and relatives), or other processor architectures like RISC-V and armhfp (32-bit ARM). + + +This Wiki is browseable at **https://sig-altarch.rocky.page** . + + + +## Contributing + +Feel free to contribute to this Wiki via pull request. + +You can test any changes locally by running it with Docker/Podman compose on your PC. Clone this wiki, `cd` into the folder, and run: + +``` +docker-compose up +``` + +It should build and run the wiki container. You can browse it and see your live edits by visiting `localhost:8000` . + + ## Continuous Integration / Continuous Deployment diff --git a/docker-compose.yml b/docker-compose.yml new file mode 100644 index 0000000..cd8ae83 --- /dev/null +++ b/docker-compose.yml @@ -0,0 +1,11 @@ +version: '3.2' +services: + wiki: + volumes: + - type: bind + source: . + target: /wiki + build: + context: . + ports: + - 8000:8000