Major docs overhaul

We finally have (hopefully) helpful docs! 🎉 Closes: #5 Closes: #78 Co-authored-by: Simon Ruderich <simon@ruderich.org>
fausecteam · Dec 2, 2023 · c51614c · c51614c
1 parent 209af33
commit c51614c
Show file tree

Hide file tree

Showing 23 changed files with 398 additions and 1,037 deletions.
diff --git a/Makefile b/Makefile
@@ -4,7 +4,7 @@ EXT_DIR ?= $(WEB_DIR)/static/ext
 DEV_MANAGE ?= src/dev_manage.py
 TESTS_DIR ?= tests
 
-.PHONY: dev build ext migrations run_web test lint clean
+.PHONY: dev build ext migrations run_web test lint run_docs clean
 .INTERMEDIATE: bootstrap.zip
 
 dev: $(WEB_DIR)/dev-db.sqlite3 ext
@@ -49,6 +49,9 @@ lint:
 	pycodestyle $(SOURCE_DIR) $(TESTS_DIR)
 	bandit --ini bandit.ini -r $(SOURCE_DIR)
 
+run_docs:
+	mkdocs serve
+
 docs_site: mkdocs.yml $(wildcard docs/* docs/*/*)
 	mkdocs build --strict
 

diff --git a/doc/controller/scoring.sql → conf/controller/scoring.sql b/doc/controller/scoring.sql → conf/controller/scoring.sql
@@ -74,6 +74,3 @@ NATURAL FULL OUTER JOIN defense
 NATURAL FULL OUTER JOIN sla
 NATURAL INNER JOIN fill
 ORDER BY team_id, service_id;
-
-ALTER MATERIALIZED VIEW scoring_scoreboard OWNER TO gameserver_controller;
-GRANT SELECT on TABLE scoring_scoreboard TO gameserver_web;
diff --git a/doc/.gitignore b/doc/.gitignore
diff --git a/doc/Makefile b/doc/Makefile
diff --git a/doc/flag.adoc b/doc/flag.adoc
diff --git a/doc/source/checker.rst b/doc/source/checker.rst