From 982508d30f887b4fe8b2a855792ae1e33f378222 Mon Sep 17 00:00:00 2001 From: Aldo Cortesi Date: Thu, 22 Feb 2018 17:21:34 +1300 Subject: All new documentation This patch does a lot. - Ditch sphinx in favor of hugo. This gives us complete control of the layout and presentation of our docs. Henceforth, docs will be hosted on our website rather than ReadTheDocs. - Create a simple, clean doc layout and theme. - Remove large parts of the documentaion. I've ditched anything that was a) woefully out of date, b) too detailed, or c) too hard to maintain in the long term. - Huge updates to the docs themselves: completely rewrite addons documentation, add docs for core concepts like commands and options, and revise and tweak a lot of the existing docs. With this patch, we're also changing the way we publish and maintain the docs. From now on, we don't publish docs for every release. Instead, the website will contain ONE set of docs for each major release. The online docs will be updated if needed as minor releases are made. Docs are free to improve during minor releases, but anything that changes behaviour sufficiently to require a doc change warrants a new major release. This also leaves us free to progressively update and improve docs out of step with our release cadence. With this new scheme, I feel CI over the docs is less important. I've removed it for now, but won't object if someone wants to add it back in. --- docs/src/static/certinstall-webapp.png | Bin 0 -> 61683 bytes docs/src/static/logo-docs.png | Bin 0 -> 9746 bytes .../schematics/how-mitmproxy-works-explicit-https.png | Bin 0 -> 78951 bytes .../static/schematics/how-mitmproxy-works-explicit.png | Bin 0 -> 65305 bytes .../how-mitmproxy-works-transparent-https.png | Bin 0 -> 79758 bytes .../schematics/how-mitmproxy-works-transparent.png | Bin 0 -> 69375 bytes docs/src/static/schematics/proxy-modes-flowchart.png | Bin 0 -> 71622 bytes docs/src/static/schematics/proxy-modes-regular.png | Bin 0 -> 18283 bytes docs/src/static/schematics/proxy-modes-reverse.png | Bin 0 -> 16719 bytes .../static/schematics/proxy-modes-transparent-1.png | Bin 0 -> 14558 bytes .../static/schematics/proxy-modes-transparent-2.png | Bin 0 -> 23375 bytes .../static/schematics/proxy-modes-transparent-3.png | Bin 0 -> 23855 bytes .../schematics/proxy-modes-transparent-wrong.png | Bin 0 -> 14719 bytes docs/src/static/schematics/proxy-modes-upstream.png | Bin 0 -> 14781 bytes docs/src/static/schematics/proxy-modes.pdf | Bin 0 -> 335485 bytes docs/src/static/screenshots/mitmproxy.png | Bin 0 -> 286915 bytes docs/src/static/screenshots/mitmweb.png | Bin 0 -> 62415 bytes docs/src/static/transparent-vms/step1_proxy.png | Bin 0 -> 246413 bytes docs/src/static/transparent-vms/step1_vbox_eth0.png | Bin 0 -> 28237 bytes docs/src/static/transparent-vms/step1_vbox_eth1.png | Bin 0 -> 28765 bytes docs/src/static/transparent-vms/step2_proxied_vm.png | Bin 0 -> 36775 bytes docs/src/static/tute-highscores/leaderboard.png | Bin 0 -> 448368 bytes docs/src/static/tute-highscores/one.png | Bin 0 -> 141443 bytes docs/src/static/tute-highscores/supermega.png | Bin 0 -> 92889 bytes 24 files changed, 0 insertions(+), 0 deletions(-) create mode 100644 docs/src/static/certinstall-webapp.png create mode 100644 docs/src/static/logo-docs.png create mode 100644 docs/src/static/schematics/how-mitmproxy-works-explicit-https.png create mode 100644 docs/src/static/schematics/how-mitmproxy-works-explicit.png create mode 100644 docs/src/static/schematics/how-mitmproxy-works-transparent-https.png create mode 100644 docs/src/static/schematics/how-mitmproxy-works-transparent.png create mode 100644 docs/src/static/schematics/proxy-modes-flowchart.png create mode 100644 docs/src/static/schematics/proxy-modes-regular.png create mode 100644 docs/src/static/schematics/proxy-modes-reverse.png create mode 100644 docs/src/static/schematics/proxy-modes-transparent-1.png create mode 100644 docs/src/static/schematics/proxy-modes-transparent-2.png create mode 100644 docs/src/static/schematics/proxy-modes-transparent-3.png create mode 100644 docs/src/static/schematics/proxy-modes-transparent-wrong.png create mode 100644 docs/src/static/schematics/proxy-modes-upstream.png create mode 100644 docs/src/static/schematics/proxy-modes.pdf create mode 100644 docs/src/static/screenshots/mitmproxy.png create mode 100644 docs/src/static/screenshots/mitmweb.png create mode 100644 docs/src/static/transparent-vms/step1_proxy.png create mode 100644 docs/src/static/transparent-vms/step1_vbox_eth0.png create mode 100644 docs/src/static/transparent-vms/step1_vbox_eth1.png create mode 100644 docs/src/static/transparent-vms/step2_proxied_vm.png create mode 100644 docs/src/static/tute-highscores/leaderboard.png create mode 100644 docs/src/static/tute-highscores/one.png create mode 100644 docs/src/static/tute-highscores/supermega.png (limited to 'docs/src/static') diff --git a/docs/src/static/certinstall-webapp.png b/docs/src/static/certinstall-webapp.png new file mode 100644 index 00000000..10e795cd Binary files /dev/null and b/docs/src/static/certinstall-webapp.png differ diff --git a/docs/src/static/logo-docs.png b/docs/src/static/logo-docs.png new file mode 100644 index 00000000..b37dbd85 Binary files /dev/null and b/docs/src/static/logo-docs.png differ diff --git a/docs/src/static/schematics/how-mitmproxy-works-explicit-https.png b/docs/src/static/schematics/how-mitmproxy-works-explicit-https.png new file mode 100644 index 00000000..1f1ca023 Binary files /dev/null and b/docs/src/static/schematics/how-mitmproxy-works-explicit-https.png differ diff --git a/docs/src/static/schematics/how-mitmproxy-works-explicit.png b/docs/src/static/schematics/how-mitmproxy-works-explicit.png new file mode 100644 index 00000000..c9ba26a7 Binary files /dev/null and b/docs/src/static/schematics/how-mitmproxy-works-explicit.png differ diff --git a/docs/src/static/schematics/how-mitmproxy-works-transparent-https.png b/docs/src/static/schematics/how-mitmproxy-works-transparent-https.png new file mode 100644 index 00000000..559cddd2 Binary files /dev/null and b/docs/src/static/schematics/how-mitmproxy-works-transparent-https.png differ diff --git a/docs/src/static/schematics/how-mitmproxy-works-transparent.png b/docs/src/static/schematics/how-mitmproxy-works-transparent.png new file mode 100644 index 00000000..3994d681 Binary files /dev/null and b/docs/src/static/schematics/how-mitmproxy-works-transparent.png differ diff --git a/docs/src/static/schematics/proxy-modes-flowchart.png b/docs/src/static/schematics/proxy-modes-flowchart.png new file mode 100644 index 00000000..e9568dac Binary files /dev/null and b/docs/src/static/schematics/proxy-modes-flowchart.png differ diff --git a/docs/src/static/schematics/proxy-modes-regular.png b/docs/src/static/schematics/proxy-modes-regular.png new file mode 100644 index 00000000..95bada08 Binary files /dev/null and b/docs/src/static/schematics/proxy-modes-regular.png differ diff --git a/docs/src/static/schematics/proxy-modes-reverse.png b/docs/src/static/schematics/proxy-modes-reverse.png new file mode 100644 index 00000000..071d3fc8 Binary files /dev/null and b/docs/src/static/schematics/proxy-modes-reverse.png differ diff --git a/docs/src/static/schematics/proxy-modes-transparent-1.png b/docs/src/static/schematics/proxy-modes-transparent-1.png new file mode 100644 index 00000000..002e0e76 Binary files /dev/null and b/docs/src/static/schematics/proxy-modes-transparent-1.png differ diff --git a/docs/src/static/schematics/proxy-modes-transparent-2.png b/docs/src/static/schematics/proxy-modes-transparent-2.png new file mode 100644 index 00000000..41997b05 Binary files /dev/null and b/docs/src/static/schematics/proxy-modes-transparent-2.png differ diff --git a/docs/src/static/schematics/proxy-modes-transparent-3.png b/docs/src/static/schematics/proxy-modes-transparent-3.png new file mode 100644 index 00000000..ee26cb4f Binary files /dev/null and b/docs/src/static/schematics/proxy-modes-transparent-3.png differ diff --git a/docs/src/static/schematics/proxy-modes-transparent-wrong.png b/docs/src/static/schematics/proxy-modes-transparent-wrong.png new file mode 100644 index 00000000..ca501e93 Binary files /dev/null and b/docs/src/static/schematics/proxy-modes-transparent-wrong.png differ diff --git a/docs/src/static/schematics/proxy-modes-upstream.png b/docs/src/static/schematics/proxy-modes-upstream.png new file mode 100644 index 00000000..d40a6494 Binary files /dev/null and b/docs/src/static/schematics/proxy-modes-upstream.png differ diff --git a/docs/src/static/schematics/proxy-modes.pdf b/docs/src/static/schematics/proxy-modes.pdf new file mode 100644 index 00000000..f07ea05e Binary files /dev/null and b/docs/src/static/schematics/proxy-modes.pdf differ diff --git a/docs/src/static/screenshots/mitmproxy.png b/docs/src/static/screenshots/mitmproxy.png new file mode 100644 index 00000000..3fd14b9d Binary files /dev/null and b/docs/src/static/screenshots/mitmproxy.png differ diff --git a/docs/src/static/screenshots/mitmweb.png b/docs/src/static/screenshots/mitmweb.png new file mode 100644 index 00000000..5f0cc925 Binary files /dev/null and b/docs/src/static/screenshots/mitmweb.png differ diff --git a/docs/src/static/transparent-vms/step1_proxy.png b/docs/src/static/transparent-vms/step1_proxy.png new file mode 100644 index 00000000..a0c94484 Binary files /dev/null and b/docs/src/static/transparent-vms/step1_proxy.png differ diff --git a/docs/src/static/transparent-vms/step1_vbox_eth0.png b/docs/src/static/transparent-vms/step1_vbox_eth0.png new file mode 100644 index 00000000..4b7b4e9b Binary files /dev/null and b/docs/src/static/transparent-vms/step1_vbox_eth0.png differ diff --git a/docs/src/static/transparent-vms/step1_vbox_eth1.png b/docs/src/static/transparent-vms/step1_vbox_eth1.png new file mode 100644 index 00000000..b994d4cb Binary files /dev/null and b/docs/src/static/transparent-vms/step1_vbox_eth1.png differ diff --git a/docs/src/static/transparent-vms/step2_proxied_vm.png b/docs/src/static/transparent-vms/step2_proxied_vm.png new file mode 100644 index 00000000..2046cc57 Binary files /dev/null and b/docs/src/static/transparent-vms/step2_proxied_vm.png differ diff --git a/docs/src/static/tute-highscores/leaderboard.png b/docs/src/static/tute-highscores/leaderboard.png new file mode 100644 index 00000000..c1be8df5 Binary files /dev/null and b/docs/src/static/tute-highscores/leaderboard.png differ diff --git a/docs/src/static/tute-highscores/one.png b/docs/src/static/tute-highscores/one.png new file mode 100644 index 00000000..78a636cf Binary files /dev/null and b/docs/src/static/tute-highscores/one.png differ diff --git a/docs/src/static/tute-highscores/supermega.png b/docs/src/static/tute-highscores/supermega.png new file mode 100644 index 00000000..d416f71f Binary files /dev/null and b/docs/src/static/tute-highscores/supermega.png differ -- cgit v1.2.3