From 07609da84e485a03585bdab1130f2d6e4fa785df Mon Sep 17 00:00:00 2001 From: brownhead Date: Thu, 11 Jun 2015 11:40:54 -0700 Subject: [PATCH] Roll back Khan Exercises and add warnings. Summary: In January, some changes were made to Khan Exercises that breaks an assumption that graphie-to-png makes. Namely that graphie will always render everything into a single SVG. This caused a regression that affected a number of content creators. See https://app.asana.com/0/27216215224639/36842953088193 for the support ticket. This change brings us back to stable behavior in gaphie-to-png. But now we're stuck. If we ever want to upgrade graphie-to-png to be up to date with Khan Exercises again, we need to do a bunch of work. I've added some warnings about this in the README that will hopefully prevent us from upgrading Khan Exercises without considering this. I've cherry picked in the color changes into a new graphie-to-png branch of Khan Exercises to prevent regressions from that. Test Plan: A.1) Serve graphie-to-png locally A.2) Go to http://localhost:5001/#27 A.3) See beautiful graph, and no errors B.1) Serve graphie-to-png locally B.2) Go to http://localhost:5001/#1 B.3) Change all references to `BLUE` to `GOLD_C` B.4) Regraph B.5) See the line turn gold I cannot get "Convert to Image" to work locally, despite my best efforts. I have confirmed that everything is being rendered into a single SVG, which gives me high confidence. I will also test once this is deployed to AWS (and rolling back is trivial), so I think this is sufficient. Reviewers: aria, emily Reviewed By: emily Differential Revision: https://phabricator.khanacademy.org/D18542 --- README.md | 6 ++++++ khan-exercises | 2 +- 2 files changed, 7 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 8594549..4e09cfc 100644 --- a/README.md +++ b/README.md @@ -2,6 +2,12 @@ A tool for converting graphie JS code to a png image, available at http://graphie-to-png.khanacademy.org/. +## Warning to Devs + +Khan Exercises is very out of date. This is because graphie-to-png will not work after some changes made in January, 2015. See [this support ticket](https://app.asana.com/0/27216215224639/36842953088193) for more information. + +Upgrading Khan Exercises would be a fairly large task, so you may want to consider other alternatives instead (like cherry picking into the `graphie-to-png` branch of Khan Exercises). + ## Local server To run this locally, fill in `secrets.py` using the template at `secrets.py.example` then run `python app.py`. diff --git a/khan-exercises b/khan-exercises index cc0d1f1..d4cb64f 160000 --- a/khan-exercises +++ b/khan-exercises @@ -1 +1 @@ -Subproject commit cc0d1f177d332da17b118a1d9fcc3f916424908d +Subproject commit d4cb64f29ea8f3404a19b336596d9d558ef13cc9