Základní dokumentace

README.md

@@ -1,14 +1,6 @@
 # pywb
 Nový věk zpřístupnění českého webového archivu.
 
-# Projektový pohled
+## Odkazy
 [Zpřístupnění sklizní z roku 2023 kurátorům pomocí pywb](https://github.com/orgs/WebarchivCZ/projects/2)
-
-## Nasazení
-Jenknins file instruuje https://jenkins.webarchiv.cz běžící na wa-dev-docker00.
-
-## Servery
-### 10.3.0.21
-- user: ansible 
-- groups: sudo
-- access via /home/ansible/.ssh/authorized_keys
+[Webarchiv.cz dokumentace Pywb](https://webarchivcz.github.io/pywb/)

docs/index.md

@@ -1,17 +1,31 @@
-# Welcome to MkDocs
+# Základní komponenty
+- [PyWb](https://pywb.readthedocs.io/en/latest/)
+- [Traefik](https://doc.traefik.io/traefik/)
+- [MkDocs](https://www.mkdocs.org)
+- [Material for MkDocs](https://squidfunk.github.io/mkdocs-material/)
+- [Github Pages](https://pages.github.com/)
 
-For full documentation visit [mkdocs.org](https://www.mkdocs.org).
-
-## Commands
-
-* `mkdocs new [dir-name]` - Create a new project.
-* `mkdocs serve` - Start the live-reloading docs server.
-* `mkdocs build` - Build the documentation site.
-* `mkdocs -h` - Print help message and exit.
-
-## Project layout
+## Github Pages
 
     mkdocs.yml    # The configuration file.
     docs/
         index.md  # The documentation homepage.
         ...       # Other markdown pages, images and other files.
+
+### Lokální dokumentace
+Příkaz ```./mkdocs.sh``` spustí lokální dokumentaci na adrese http://0.0.0.0:8000/ 
+
+# Nasazení
+
+## Pywb & Traefik
+Jenknins file instruuje https://jenkins.webarchiv.cz běžící na wa-dev-docker00.
+
+## Infrastruktura
+ - host: 10.3.0.21
+ - groups: sudo
+ - Jenkins access via /home/ansible/.ssh/authorized_keys
+
+### PyWb & Traefik
+ - Spuštění: 
+    - Test: /home/ansible/pywb/run-test.sh
+    - Produkce: /home/ansible/pywb/run-test.sh

mkdocs.sh

@@ -0,0 +1,9 @@
+#!/usr/bin/env bash
+
+# Make Bash Great Again
+set -o errexit # exit when a command fails.
+set -o nounset # exit when using undeclared variables
+set -o pipefail # catch non-zero exit code in pipes
+# set -o xtrace # uncomment for bug hunting
+
+docker run --rm -it -p 8000:8000 -v ${PWD}:/docs squidfunk/mkdocs-material

mkdocs.yml

@@ -1 +1,41 @@
-site_name: My Docs
+site_name: Nový věk zpřístupnění českého webového archivu.
+# https://squidfunk.github.io/mkdocs-material/setup/
+
+theme:
+  name: material
+  palette:
+    - primary: black
+    # Palette toggle for light mode
+    - scheme: default
+      toggle:
+        icon: material/brightness-7
+        name: Switch to dark mode
+
+    # Palette toggle for dark mode
+    - scheme: slate
+      toggle:
+        icon: material/brightness-4
+        name: Switch to light mode
+  features:
+    - navigation.instant
+    - navigation.instant.prefetch
+    - navigation.instant.progress
+    - navigation.tracking
+    # - navigation.tabs
+    # - navigation.tabs.sticky
+    # - navigation.sections
+    # - navigation.expand
+    # - navigation.path # sponsors only feature, not working for us
+    - navigation.indexes
+    - toc.follow
+    # - toc.integrate
+    - navigation.top
+    - search.suggest
+    - search.highlight
+    - search.share
+    - social
+# plugins:
+# - blog:
+#     blog_dir: News
+#     blog_toc: true
+# - tags