Disables the feedback mechanism (#1483)

* Disables the feedback mechanism

* Ignore generated files and build the one-page book (#1482)

* Apply suggestion from @chrishtr

Change from email to github

---------

Co-authored-by: Chris Harrelson <3453258+chrishtr@users.noreply.github.com>

Author: pavpanchekha

.gitignore

@@ -30,4 +30,7 @@ package.json
 .coverage
 bin/
 lib/
-pyvenv.cfg
+pyvenv.cfg
+links.txt
+integra
+infra/*.pickle

Makefile

@@ -15,7 +15,7 @@ EXAMPLE_HTML=$(patsubst src/example%.html,%,$(wildcard src/example*.html))
 EXAMPLE_JS=$(patsubst src/example%.js,%,$(wildcard src/example*.js))
 EXAMPLE_CSS=$(patsubst src/example%.css,%,$(wildcard src/example*.css))
 
-book: $(patsubst %,www/%.html,$(CHAPTERS)) www/rss.xml widgets examples www/index.html
+book: $(patsubst %,www/%.html,$(CHAPTERS)) www/rss.xml widgets examples www/index.html www/onepage.html
 examples: $(patsubst %,www/examples/example%.html,$(EXAMPLE_HTML)) \
 	$(patsubst %,www/examples/example%.js,$(EXAMPLE_JS)) \
 	$(patsubst %,www/examples/example%.css,$(EXAMPLE_CSS))

README.md

@@ -17,11 +17,11 @@ The source code contains:
 - A template and code for converting the book to HTML, in `infra/`
 - Chapter-by-chapter implementations of the browser, in `src/`
 - Styling for the book's website, in `www/`
-- The book's built-in feedback system, in `www/`, including JavaScript
-  and the Python backend.
+- The Python backend for the book's former feedback system, in `www/` and
+  `infra/`.
 
-We prefer to receive typos and small comments on the text using the
-book's built-in feedback tools, which you can enable with `Ctrl+E`.
+The book's built-in feedback system is disabled. Please [open a GitHub issue](https://github.com/browserengineering/book/issues)
+with typos or small comments about the text.
 
 You can run the book's built-in checks with:
 

book/invalidation.md

@@ -51,10 +51,9 @@ there are other text editing APIs that can't be. For example, the
     layout, just paint.
 
 [^amazing-ce]: The `contenteditable` attribute can turn any element on
-    any page into a living document. It's how we implemented the "typo"
-    feature for this book: type `Ctrl-E` (or `Cmd-E` on a Mac) to turn
-    it on. The source code is [on the website](https://browser.engineering/feedback.js); see the
-    `typo_mode` function for the `contenteditable` attribute.
+    any page into a living document. When we were first writing this book,
+    we used it to implement a typo feature on this website, so users could
+    make corrections and send them to us for review.
 
 ::: {.web-only .demo contenteditable=true}
 Click on this <i>formatted</i> <b>text</b> to edit it, including rich text!

book/preface.md

@@ -111,11 +111,9 @@ me to join the adventure. (Turns out Pavel and I had the same idea!)
 A final note
 ============
 
-This book is, and will remain, a work in progress. Please leave
-comments and mark typos; the book has built-in feedback tools, which
-you can enable with `Ctrl-E` (or `Cmd-E` on a Mac). The full source
-code is also available [on GitHub][github], though we prefer to
-receive comments through the built-in tools.
+This book is, and will remain, a work in progress. Please [file a github issue](https://github.com/browserengineering/book/issues/new)
+with comments or typos. The full source code is also available
+[on GitHub][github].
 
 [github]: https://github.com/browserengineering/book
 

infra/api.py

@@ -132,20 +132,20 @@ def __iter__(self):
 
 DATA = Data("db.json")
 
+def feedback_disabled():
+    bottle.abort(410, "Feedback submission is disabled.")
+
 @bottle.post("/api/typo")
 def typo():
-    data = json.load(bottle.request.body)
-    DATA.typo(**data)
+    feedback_disabled()
 
 @bottle.post("/api/text_comment")
 def text_comment():
-    data = json.load(bottle.request.body)
-    DATA.text_comment(**data)
+    feedback_disabled()
 
 @bottle.post("/api/chapter_comment")
 def comment():
-    data = json.load(bottle.request.body)
-    DATA.chapter_comment(**data)
+    feedback_disabled()
 
 @bottle.post("/api/quiz_telemetry", method=['OPTIONS', 'POST'])
 def quiz_telemetry():

infra/template.html

@@ -118,15 +118,10 @@ <h1 class="title">$title$</h1>
 </nav>
 $endif$
 
-$if(chapter)$
-<p>Did you find this chapter useful? <button id=feedback-button>Send us feedback!</button></p>
-$endif$
-
 <footer>
   &copy; 2018&ndash;2023 <a href="https://pavpanchekha.com">Pavel Panchekha</a> &amp; <a href="https://twitter.com/chrishtr">Chris Harrelson</a>
 </footer>
 
-<script type="text/javascript" defer src="$base$feedback.js"></script>
 <script type="text/javascript" defer src="$base$book.js"></script>
 $if(show_quiz)$<script type="text/javascript" defer async src="$base$quiz-embed.iife.js"></script>$endif$
 </body>

www/feedback.js

@@ -5,6 +5,10 @@
 // This code is written in a bit of an odd style to avoid error
 // messages in the WBE browser. There's a lot of old-school JS.
 
+// Retained for historical reference, but the public feedback mechanism is
+// disabled. The server also rejects all feedback submissions.
+var FEEDBACK_ENABLED = false;
+
 var chapter_overlay;
 
 function ctrl_key_pressed(e) {
@@ -25,6 +29,7 @@ function ctrl_key_name() {
 
 if (document.addEventListener)
 document.addEventListener("DOMContentLoaded", function() {
+    if (!FEEDBACK_ENABLED) return;
     if (window.localStorage["edit"] == "true") {
         typo_mode();
     }

www/thanks.view

@@ -45,7 +45,7 @@ We want to thank our
 
 <p>
 Moreover, we thank <em>contributors</em> who submitted typo fixes,
-questions, and comments through the book's built-in feedback tools,
+questions, and comments through a feedback tool in earlier drafts of this book,
 or through Github:
 {{", ".join(contribute[:-1])}}, and {{contribute[-1]}}.
 </p>