From 2754123c7b25f3b482b053ab387dbd7dfae27c81 Mon Sep 17 00:00:00 2001 From: Joseph Date: Fri, 11 Oct 2024 17:04:35 +0200 Subject: [PATCH 1/3] feat(mkdocs): Add the base file --- bin/docs | 21 +++++++++++++++++++++ mkdocs.yml | 13 +++++++++++++ 2 files changed, 34 insertions(+) create mode 100755 bin/docs create mode 100644 mkdocs.yml diff --git a/bin/docs b/bin/docs new file mode 100755 index 00000000..0f8bbb04 --- /dev/null +++ b/bin/docs @@ -0,0 +1,21 @@ +#!/bin/bash + +DIR="$( cd "$( dirname "${BASH_SOURCE[0]}" )" && pwd )" +cd "$DIR/.." +zon_mkdocs_image="europe-west3-docker.pkg.dev/zeitonline-engineering/docker-zon/zon-mkdocs:latest" + +docker pull $zon_mkdocs_image + +COMMAND=${1:-html} +case $COMMAND in + serve) + docker run --rm -it -p 8000:8000 -v ${PWD}:/docs $zon_mkdocs_image + ;; + html) + docker run --rm -v ${PWD}:/docs $zon_mkdocs_image build --site-dir public + ;; + *) + echo "Unrecognized command: $COMMAND" + exit 1 + ;; +esac diff --git a/mkdocs.yml b/mkdocs.yml new file mode 100644 index 00000000..c9435110 --- /dev/null +++ b/mkdocs.yml @@ -0,0 +1,13 @@ +INHERIT: /zon/common_config.yaml +site_name: Briefkasten +repo_url: https://github.com/ZeitOnline/briefkasten + +nav: + - index.md + - Deployment: + - index.md + - monitoring.md + - Application: + - develop.md + - workings.md + - i18n.md From cb0caf853bc2db025ce6678d6bc0d539c60ad0bb Mon Sep 17 00:00:00 2001 From: Joseph Date: Fri, 11 Oct 2024 17:05:21 +0200 Subject: [PATCH 2/3] fix: modify the index and delete overview --- docs/index.md | 26 +++++++++----------------- docs/overview.md | 9 --------- 2 files changed, 9 insertions(+), 26 deletions(-) delete mode 100644 docs/overview.md diff --git a/docs/index.md b/docs/index.md index a0583c8c..54c2a4c3 100644 --- a/docs/index.md +++ b/docs/index.md @@ -1,25 +1,17 @@ -```{include} overview.md -``` +# ZEIT Online Briefkasten -Deployment +The `briefkasten` (German for letterbox) is a reasonably secure web application for submitting content anonymously. -: This section contains all the information on how to install, configure and run your own instance of the briefkasten stack. +It allows to upload attachments which are then sanitized of a number of meta-data which could compromise the submitters identity. Next, the sanitized files are encrypted via GPG and sent via email to a pre-configured list of recipients. The original (potentially 'dirty') files are then deleted from the file system of the server. Thus, neither should admins with access to the server be able to access any submissions, nor should any of the recipients have access to the unsanitized raw material. -```{toctree} -:maxdepth: 2 +Upon successful upload the submitter receives a unique URL with a token that he or she can use to access any replies the recipients may post. That reply is the only data persisted on the server. -deployment/index -deployment/monitoring -``` +The implementation doesn't just contain the application itself but includes a complete deployment setup following what we believe to be best practices so that anybody should be able to host their own secure `briefkasten` with minimal setup pain. -Application +Deployment -> This section contains information on the inner workings of the application and how to develop or extend it or how to create a custom theme for it. +> This section contains all the information on how to install, configure and run your own instance of the briefkasten stack. -```{toctree} -:maxdepth: 2 +Application -application/develop -application/workings -application/i18n -``` +> This section contains information on the inner workings of the application and how to develop or extend it or how to create a custom theme for it. diff --git a/docs/overview.md b/docs/overview.md deleted file mode 100644 index 32f13ad0..00000000 --- a/docs/overview.md +++ /dev/null @@ -1,9 +0,0 @@ -# ZEIT Online Briefkasten - -The `briefkasten` (German for letterbox) is a reasonably secure web application for submitting content anonymously. - -It allows to upload attachments which are then sanitized of a number of meta-data which could compromise the submitters identity. Next, the sanitized files are encrypted via GPG and sent via email to a pre-configured list of recipients. The original (potentially 'dirty') files are then deleted from the file system of the server. Thus, neither should admins with access to the server be able to access any submissions, nor should any of the recipients have access to the unsanitized raw material. - -Upon successful upload the submitter receives a unique URL with a token that he or she can use to access any replies the recipients may post. That reply is the only data persisted on the server. - -The implementation doesn't just contain the application itself but includes a complete deployment setup following what we believe to be best practices so that anybody should be able to host their own secure `briefkasten` with minimal setup pain. From cf492c5a5647aded9fd9e2a8007d24f564776d68 Mon Sep 17 00:00:00 2001 From: Martin Stolle Date: Mon, 14 Oct 2024 09:01:07 +0200 Subject: [PATCH 3/3] docs: remove everything related to sphinx --- docs/Makefile | 177 --------------------------------------- docs/_build/.gitignore | 1 - docs/application/i18n.md | 5 +- docs/compose.yaml | 10 --- docs/conf.py | 13 --- docs/index.md | 4 +- mkdocs.yml | 10 +-- 7 files changed, 9 insertions(+), 211 deletions(-) delete mode 100644 docs/Makefile delete mode 100644 docs/_build/.gitignore delete mode 100644 docs/compose.yaml delete mode 100644 docs/conf.py diff --git a/docs/Makefile b/docs/Makefile deleted file mode 100644 index 283548cf..00000000 --- a/docs/Makefile +++ /dev/null @@ -1,177 +0,0 @@ -# Makefile for Sphinx documentation -# - -# You can set these variables from the command line. -SPHINXOPTS = -SPHINXBUILD = sphinx-build -PAPER = -BUILDDIR = _build - -# User-friendly check for sphinx-build -ifeq ($(shell which $(SPHINXBUILD) >/dev/null 2>&1; echo $$?), 1) -$(error The '$(SPHINXBUILD)' command was not found. Make sure you have Sphinx installed, then set the SPHINXBUILD environment variable to point to the full path of the '$(SPHINXBUILD)' executable. Alternatively you can add the directory with the executable to your PATH. If you don't have Sphinx installed, grab it from http://sphinx-doc.org/) -endif - -# Internal variables. -PAPEROPT_a4 = -D latex_paper_size=a4 -PAPEROPT_letter = -D latex_paper_size=letter -ALLSPHINXOPTS = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) . -# the i18n builder cannot share the environment and doctrees with the others -I18NSPHINXOPTS = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) . - -.PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest gettext - -help: - @echo "Please use \`make ' where is one of" - @echo " html to make standalone HTML files" - @echo " dirhtml to make HTML files named index.html in directories" - @echo " singlehtml to make a single large HTML file" - @echo " pickle to make pickle files" - @echo " json to make JSON files" - @echo " htmlhelp to make HTML files and a HTML help project" - @echo " qthelp to make HTML files and a qthelp project" - @echo " devhelp to make HTML files and a Devhelp project" - @echo " epub to make an epub" - @echo " latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter" - @echo " latexpdf to make LaTeX files and run them through pdflatex" - @echo " latexpdfja to make LaTeX files and run them through platex/dvipdfmx" - @echo " text to make text files" - @echo " man to make manual pages" - @echo " texinfo to make Texinfo files" - @echo " info to make Texinfo files and run them through makeinfo" - @echo " gettext to make PO message catalogs" - @echo " changes to make an overview of all changed/added/deprecated items" - @echo " xml to make Docutils-native XML files" - @echo " pseudoxml to make pseudoxml-XML files for display purposes" - @echo " linkcheck to check all external links for integrity" - @echo " doctest to run all doctests embedded in the documentation (if enabled)" - -clean: - rm -rf $(BUILDDIR)/* - -html: - $(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html - @echo - @echo "Build finished. The HTML pages are in $(BUILDDIR)/html." - -dirhtml: - $(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml - @echo - @echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml." - -singlehtml: - $(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml - @echo - @echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml." - -pickle: - $(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle - @echo - @echo "Build finished; now you can process the pickle files." - -json: - $(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json - @echo - @echo "Build finished; now you can process the JSON files." - -htmlhelp: - $(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp - @echo - @echo "Build finished; now you can run HTML Help Workshop with the" \ - ".hhp project file in $(BUILDDIR)/htmlhelp." - -qthelp: - $(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp - @echo - @echo "Build finished; now you can run "qcollectiongenerator" with the" \ - ".qhcp project file in $(BUILDDIR)/qthelp, like this:" - @echo "# qcollectiongenerator $(BUILDDIR)/qthelp/bsdploy.qhcp" - @echo "To view the help file:" - @echo "# assistant -collectionFile $(BUILDDIR)/qthelp/bsdploy.qhc" - -devhelp: - $(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp - @echo - @echo "Build finished." - @echo "To view the help file:" - @echo "# mkdir -p $$HOME/.local/share/devhelp/bsdploy" - @echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/bsdploy" - @echo "# devhelp" - -epub: - $(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub - @echo - @echo "Build finished. The epub file is in $(BUILDDIR)/epub." - -latex: - $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex - @echo - @echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex." - @echo "Run \`make' in that directory to run these through (pdf)latex" \ - "(use \`make latexpdf' here to do that automatically)." - -latexpdf: - $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex - @echo "Running LaTeX files through pdflatex..." - $(MAKE) -C $(BUILDDIR)/latex all-pdf - @echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex." - -latexpdfja: - $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex - @echo "Running LaTeX files through platex and dvipdfmx..." - $(MAKE) -C $(BUILDDIR)/latex all-pdf-ja - @echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex." - -text: - $(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text - @echo - @echo "Build finished. The text files are in $(BUILDDIR)/text." - -man: - $(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man - @echo - @echo "Build finished. The manual pages are in $(BUILDDIR)/man." - -texinfo: - $(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo - @echo - @echo "Build finished. The Texinfo files are in $(BUILDDIR)/texinfo." - @echo "Run \`make' in that directory to run these through makeinfo" \ - "(use \`make info' here to do that automatically)." - -info: - $(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo - @echo "Running Texinfo files through makeinfo..." - make -C $(BUILDDIR)/texinfo info - @echo "makeinfo finished; the Info files are in $(BUILDDIR)/texinfo." - -gettext: - $(SPHINXBUILD) -b gettext $(I18NSPHINXOPTS) $(BUILDDIR)/locale - @echo - @echo "Build finished. The message catalogs are in $(BUILDDIR)/locale." - -changes: - $(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes - @echo - @echo "The overview file is in $(BUILDDIR)/changes." - -linkcheck: - $(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck - @echo - @echo "Link check complete; look for any errors in the above output " \ - "or in $(BUILDDIR)/linkcheck/output.txt." - -doctest: - $(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest - @echo "Testing of doctests in the sources finished, look at the " \ - "results in $(BUILDDIR)/doctest/output.txt." - -xml: - $(SPHINXBUILD) -b xml $(ALLSPHINXOPTS) $(BUILDDIR)/xml - @echo - @echo "Build finished. The XML files are in $(BUILDDIR)/xml." - -pseudoxml: - $(SPHINXBUILD) -b pseudoxml $(ALLSPHINXOPTS) $(BUILDDIR)/pseudoxml - @echo - @echo "Build finished. The pseudo-XML files are in $(BUILDDIR)/pseudoxml." diff --git a/docs/_build/.gitignore b/docs/_build/.gitignore deleted file mode 100644 index 33662f55..00000000 --- a/docs/_build/.gitignore +++ /dev/null @@ -1 +0,0 @@ -/* diff --git a/docs/application/i18n.md b/docs/application/i18n.md index 160c226c..b743f072 100644 --- a/docs/application/i18n.md +++ b/docs/application/i18n.md @@ -1,8 +1,7 @@ # Internationalization -:::{note} -The i18n Feature is currently not actively supported anymore - the workaround is to translate the texts using the theming mechanism, where you can replace tagged markup with translated versions. -::: +!!! note + The i18n Feature is currently not actively supported anymore - the workaround is to translate the texts using the theming mechanism, where you can replace tagged markup with translated versions. All user facing text of the `briefkasen` application are translated using a `gettext` messsage catalog. To customize and update these messages you must: diff --git a/docs/compose.yaml b/docs/compose.yaml deleted file mode 100644 index f4976c63..00000000 --- a/docs/compose.yaml +++ /dev/null @@ -1,10 +0,0 @@ -services: - docs: - image: europe-west3-docker.pkg.dev/zeitonline-engineering/docker-zon/sphinx-zon:latest - command: sphinx-autobuild --host localhost /docs /docs/htdocs - network_mode: host - restart: always - volumes: - - .:/docs -networks: - default: {} diff --git a/docs/conf.py b/docs/conf.py deleted file mode 100644 index d08d79ad..00000000 --- a/docs/conf.py +++ /dev/null @@ -1,13 +0,0 @@ -project = 'Briefkasten' -copyright = 'ZEIT Online' - -extensions = [ - 'myst_parser', - 'sphinx.ext.autodoc', - 'sphinx.ext.doctest', -] -source_suffix = {'.md': 'markdown'} -master_doc = 'index' -pygments_style = 'sphinx' -html_theme = 'alabaster' -htmlhelp_basename = 'briefkasten' diff --git a/docs/index.md b/docs/index.md index 54c2a4c3..07aa9a3d 100644 --- a/docs/index.md +++ b/docs/index.md @@ -8,10 +8,10 @@ Upon successful upload the submitter receives a unique URL with a token that he The implementation doesn't just contain the application itself but includes a complete deployment setup following what we believe to be best practices so that anybody should be able to host their own secure `briefkasten` with minimal setup pain. -Deployment +[Deployment](deployment/index.md) > This section contains all the information on how to install, configure and run your own instance of the briefkasten stack. -Application +[Application](application/develop.md) > This section contains information on the inner workings of the application and how to develop or extend it or how to create a custom theme for it. diff --git a/mkdocs.yml b/mkdocs.yml index c9435110..824f3655 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -5,9 +5,9 @@ repo_url: https://github.com/ZeitOnline/briefkasten nav: - index.md - Deployment: - - index.md - - monitoring.md + - deployment/index.md + - deployment/monitoring.md - Application: - - develop.md - - workings.md - - i18n.md + - application/develop.md + - application/workings.md + - application/i18n.md