From 80c633ea295fc339d9a57d529c5ac756425b0107 Mon Sep 17 00:00:00 2001 From: Fabian Arrotin Date: Dec 09 2021 14:04:35 +0000 Subject: Initial skeleton for SIG Guide #543 Signed-off-by: Fabian Arrotin --- diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..bd816b7 --- /dev/null +++ b/.gitignore @@ -0,0 +1,2 @@ +site +site/ diff --git a/README.md b/README.md new file mode 100644 index 0000000..d34d0e2 --- /dev/null +++ b/README.md @@ -0,0 +1,31 @@ +# CentOS SIG Guid documentation + +This git repository contains the needed sources (markdown format) used to generate the CentOS SIG Guide website. + +It uses [mkdocs](https://mkdocs.org) but with a specific [material](https://squidfunk.github.io/mkdocs-material) theme + +## How to test locally +The easiest way is just to use podman and a container: + +``` +podman pull docker.io/squidfunk/mkdocs-material:latest +``` + +You can then enter the directory where you have cloned this repository (where mkdocs.yml is) and then you can run the following development site (that will automatically refresh on each new file/change) : + +``` +podman run --rm -it -p 8000:8000 -v ${PWD}:/docs:z squidfunk/mkdocs-material +``` + +You can now open your browser to http://localhost:8000 and you'll be able to see `live` your edit/changes + +## How to render/build the site as static pages + +Still using same podman container, but instead call it like this : + +``` +podman run --rm -it -v ${PWD}:/docs:z squidfunk/mkdocs-material build + +``` + +Worth knowing that the goal is to just develop locally , and then git commit/push as the built site will automatically be rendered in the next minutes on public website diff --git a/docs/auth.md b/docs/auth.md new file mode 100644 index 0000000..ed45579 --- /dev/null +++ b/docs/auth.md @@ -0,0 +1,3 @@ +# Authentication + +## SIG group membership diff --git a/docs/cbs.md b/docs/cbs.md new file mode 100644 index 0000000..f93eb0b --- /dev/null +++ b/docs/cbs.md @@ -0,0 +1 @@ +# Koji/CBS buildsystem diff --git a/docs/ci.md b/docs/ci.md new file mode 100644 index 0000000..f00b526 --- /dev/null +++ b/docs/ci.md @@ -0,0 +1 @@ +# Testing diff --git a/docs/delivery.md b/docs/delivery.md new file mode 100644 index 0000000..97715e0 --- /dev/null +++ b/docs/delivery.md @@ -0,0 +1 @@ +# Delivery diff --git a/docs/git.md b/docs/git.md new file mode 100644 index 0000000..225bd90 --- /dev/null +++ b/docs/git.md @@ -0,0 +1 @@ +# Git/lookaside diff --git a/docs/img/centos.png b/docs/img/centos.png new file mode 100644 index 0000000..fa510d6 Binary files /dev/null and b/docs/img/centos.png differ diff --git a/docs/index.md b/docs/index.md new file mode 100644 index 0000000..beb6f20 --- /dev/null +++ b/docs/index.md @@ -0,0 +1 @@ +# CentOS SIG Guide diff --git a/mkdocs.yml b/mkdocs.yml new file mode 100644 index 0000000..4c27bfa --- /dev/null +++ b/mkdocs.yml @@ -0,0 +1,33 @@ +site_name: CentOS SIG Guide +site_url: https://sigs.centos.org/guide/ + +repo_url: https://git.centos.org/centos/sig-guide +repo_name: centos/sig-guide + +nav: + - index.md + - Authentication: auth.md + - Building: + - git.md + - cbs.md + - ci.md + - delivery.md + +theme: + name: material + logo: img/centos.png + favicon: img/favicon-centos.ico + features: + - navigation.tabs + - navigation.expand + - navigation.top + - toc.integrate + palette: + primary: indigo + accent: deep orange + +markdown_extensions: + - toc: + baselevel: 4 + permalink: true + - admonition