Remove 'asDiagram' infrastructure (#5422)

* test(marbles): change marble diagram tests to normal tests * docs(testing): hide internal testing document * docs(marbles): add swirly to generate marble diagrams * docs(marbles): inline marble svg * docs(marbles): inline marble svg * build(marbles): create node script to generate marbles based on swirly * build(docs): remove generated marbles from repo * build(docs): cleanup already pushed marble * lint(concatAll): remove trailing whitespace * build(docs-app): fix weird merge issues * docs(marbles): move marble scripts over to docs app * docs(marbles): explicitly specify swirly packages Co-authored-by: Jan-Niklas Wortmann <6104311+JWO719@users.noreply.github.com>
ReactiveX · May 28, 2020 · d608cf3 · d608cf3
1 parent d365b36
commit d608cf3
Show file tree

Hide file tree

Showing 128 changed files with 1,155 additions and 1,303 deletions.
diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md
@@ -5,7 +5,6 @@ If your PR is the addition of a new operator, please make sure all these boxes a
 
 - [ ] Add the operator to Rx
 - [ ] It must have a `-spec.ts` tests file covering the canonical corner cases, with marble diagram tests
-- [ ] If possible, write a `asDiagram` test case too, for PNG diagram generation purposes
 - [ ] The spec file should have a type definition test at the end of the spec to verify type definition for various use cases
 - [ ] The operator must be documented in JSDoc style in the implementation file, including also the PNG marble diagram image
 - [ ] The operator should be listed in `docs_app/content/guide/operators.md` in a category of operators

diff --git a/docs_app/.gitignore b/docs_app/.gitignore
@@ -47,3 +47,6 @@ Thumbs.db
 
 # copied dependencies
 src/assets/js/lunr*
+
+assets/images/svgs/*
+!assets/images/svgs/.gitkeep
diff --git a/docs_app/assets/images/svgs/.gitkeep b/docs_app/assets/images/svgs/.gitkeep
diff --git a/docs_app/content/guide/operators.md b/docs_app/content/guide/operators.md
@@ -111,7 +111,7 @@ To explain how operators work, textual descriptions are often not enough. Many o
 
 Below you can see the anatomy of a marble diagram.
 
-<img src="assets/images/guide/marble-diagram-anatomy.svg">
+<img src="../src/assets/images/guide/marble-diagram-anatomy.svg">
 
 Throughout this documentation site, we extensively use marble diagrams to explain how operators work. They may be really useful in other contexts too, like on a whiteboard or even in our unit tests (as ASCII diagrams).
 

diff --git a/docs_app/content/navigation.json b/docs_app/content/navigation.json
@@ -1,24 +1,23 @@
 {
-  "TopBar": [
-    {
-      "url": "guide/overview",
-      "title": "Overview"
-    },
-    {
-      "url": "api",
-      "title": "Reference"
-    },
-    {
-      "url": "guide/v6/migration",
-      "title": "Migration"
-    },
-    {
-      "url": "team",
-      "title": "Team"
-    }
-  ],
-
-  "TopBarNarrow": [],
+	"TopBar": [
+		{
+			"url": "guide/overview",
+			"title": "Overview"
+		},
+		{
+			"url": "api",
+			"title": "Reference"
+		},
+		{
+			"url": "guide/v6/migration",
+			"title": "Migration"
+		},
+		{
+			"url": "team",
+			"title": "Team"
+		}
+	],
+	"TopBarNarrow": [],
 	"SideNav": [
 		{
 			"url": "guide/overview",
@@ -28,8 +27,8 @@
 				{
 					"url": "guide/observable",
 					"title": "Observables"
-        },
-        {
+				},
+				{
 					"url": "guide/observer",
 					"title": "Observer"
 				},
@@ -41,26 +40,17 @@
 					"url": "guide/subscription",
 					"title": "Subscription"
 				},
-        {
+				{
 					"url": "guide/subject",
 					"title": "Subjects"
 				},
-        {
+				{
 					"url": "guide/scheduler",
 					"title": "Scheduler"
-        },
+				},
 				{
-					"title": "Testing",
-					"children": [
-						{
-							"url": "guide/testing/marble-testing",
-							"title": "Marble Testing"
-						},
-						{
-							"url": "guide/testing/internal-marble-tests",
-							"title": "Contribute tests to RxJS"
-						}
-					]
+					"url": "guide/testing/marble-testing",
+					"title": "Marble Testing"
 				}
 			]
 		},
@@ -69,16 +59,16 @@
 			"title": "Installation",
 			"tooltip": "Installation"
 		},
-    {
-      "url": "api",
-      "title": "Reference",
-      "tooltip": "RxJS Reference"
-    },
-    {
-      "tooltip": "Operator Decision Tree",
-      "url": "operator-decision-tree",
-      "title": "Operator Decision Tree"
-    },
+		{
+			"url": "api",
+			"title": "Reference",
+			"tooltip": "RxJS Reference"
+		},
+		{
+			"tooltip": "Operator Decision Tree",
+			"url": "operator-decision-tree",
+			"title": "Operator Decision Tree"
+		},
 		{
 			"title": "About Version 6",
 			"children": [
@@ -98,9 +88,9 @@
 			]
 		},
 		{
-      "url": "resources",
-      "title": "External Resources",
-      "tooltip": "External Resources"
+			"url": "resources",
+			"title": "External Resources",
+			"tooltip": "External Resources"
 		},
 		{
 			"url": "code-of-conduct",
@@ -109,4 +99,4 @@
 		}
 	],
 	"docVersions": []
-}
+}