110swag / docs

Commit ae44d49d80f2ee620be5a694d4252904c03ce8e3

Authored by Kevin Mach 2015-06-04 22:46:15 -0700

Exists in master

updated screen sequence diagrams (left side of list)

Showing 11 changed files with 43 additions and 43 deletions Side-by-side Diff

screen_sequence_diagrams/add_class.dot
screen_sequence_diagrams/blank_out_words.dot
screen_sequence_diagrams/change_password.dot
screen_sequence_diagrams/configure_account_notifications.dot
screen_sequence_diagrams/contact_admin.dot
screen_sequence_diagrams/drop_class.dot
screen_sequence_diagrams/edit_flashcard.dot
screen_sequence_diagrams/filter_cards.dot
screen_sequence_diagrams/fix_flashcard.dot
screen_sequence_diagrams/flag_inappropriate_cards.dot
screen_sequence_diagrams/hide_card.dot

...	...	@@ -6,7 +6,7 @@
6	6	nodesep=1.4;
7	7	labelloc="t";
8	8	label = "[A3] Add a Class";
9		- "Sidebar Menu"[center=true, fillcolor="#aaaaff", style=filled,pos="0,0!"];
	9	+ "Navigation Menu"[center=true, fillcolor="#aaaaff", style=filled,pos="0,0!"];
10	10	"Controller"[center=true, fillcolor="#aaaaff", style=filled, shape=diamond,
11	11	fixedsize=true, width=1.4, height=1.4];
12	12	"POST /api/sections/{pk}/enroll"[shape=none];
13	13
14	14
...	...	@@ -21,16 +21,16 @@
21	21	"Controller"[center=true, fillcolor="#aaaaff", style=filled, shape=diamond,
22	22	fixedsize=true, width=1.4, height=1.4];
23	23	"WhiteListCheck"[center=true, fillcolor="#aaaaff", style=filled, style=filled];
24		- "Sidebar Menu" -> "POST /api/sections/{pk}/enroll"[dir=none];
	24	+ "Navigation Menu" -> "POST /api/sections/{pk}/enroll"[dir=none];
25	25	"POST /api/sections/{pk}/enroll" -> "Controller";
26		- "Controller" -> "FAILURE"[dir=none];
27		- "FAILURE" -> "Sidebar Menu";
28		- "Controller" -> "SUCCESS"[dir=none];
	26	+ "Controller" -> "FAILURE";
	27	+ "FAILURE" -> "Navigation Menu";
	28	+ "Controller" -> "SUCCESS";
29	29	"SUCCESS"->"WhiteListCheck";
30		- "WhiteListCheck" -> "Permission Denied: \n User cannot be enrolled in class"[dir=none];
31		- "WhiteListCheck" -> "Success! \n User is added to class"[dir=none];
32		- "Success! \n User is added to class" -> "Sidebar Menu";
33		- "Permission Denied: \n User cannot be enrolled in class" -> "Sidebar Menu";
	30	+ "WhiteListCheck" -> "Permission Denied: \n User cannot be enrolled in class";
	31	+ "WhiteListCheck" -> "Success! \n User is added to class";
	32	+ "Success! \n User is added to class" -> "Navigation Menu";
	33	+ "Permission Denied: \n User cannot be enrolled in class" -> "Navigation Menu";
34	34
35	35	}

...	...	@@ -13,13 +13,13 @@
13	13
14	14	"View Deck" -> "Flashcard";
15	15	"Flashcard" -> "Edit Flashcard Page";
16		- "Edit Flashcard Page" -> "POST /api/flashcards/{pk}"[dir=none];
	16	+ "Edit Flashcard Page" -> "POST /api/flashcards/{pk}";
17	17	"POST /api/flashcards/{pk}" -> "Controller";
18	18
19	19	//Only blanks(mask) altered
20	20	"Only mask altered"[shape=none];
21	21	"Server Updates FlashcardMask object"[fillcolor="#aaaaff", style=filled,pos="0,0!"];
22		- "Controller" -> "Only mask altered"[dir=none];
	22	+ "Controller" -> "Only mask altered";
23	23	"Only mask altered" -> "Server Updates FlashcardMask object";
24	24	"Server Updates FlashcardMask object" -> "View Deck";
25	25

...	...	@@ -6,7 +6,7 @@
6	6	nodesep=1.4;
7	7	labelloc="t";
8	8	label="[A5] Change password & [A6] Reset password";
9		- "Sidebar Menu"[center=true, fillcolor="#aaaaff", style=filled,pos="0,0!"];
	9	+ "Navigation Menu/Settings"[center=true, fillcolor="#aaaaff", style=filled,pos="0,0!"];
10	10	"Controller"[center=true, fillcolor="#aaaaff", style=filled, shape = diamond];
11	11	"POST /api/request_password_reset"[shape=none];
12	12	labelfloat=true;
13	13
14	14
...	...	@@ -14,14 +14,14 @@
14	14
15	15	"Controller"[center=true, fillcolor="#aaaaff", style=filled, shape = diamond,
16	16	fixedsize=true, width=1.4, height=1.4];
17		- "Sidebar Menu/Settings" -> "POST /api/request_password_reset"[dir=none];
	17	+ "Navigation Menu/Settings" -> "POST /api/request_password_reset"[dir=none];
18	18	"POST /api/request_password_reset" -> "Controller";
19	19	"Controller" -> "Email";
20	20	"Failure: User did not\nchange password"[shape=none];
21		- "Email" -> "Failure: User did not\nchange password"[dir=none];
22		- "Failure: User did not\nchange password" -> "Sidebar Menu";
	21	+ "Email" -> "Failure: User did not\nchange password";
	22	+ "Failure: User did not\nchange password" -> "Navigation Menu";
23	23	"Success: User \nchanged password"[shape=none];
24		- "Email" -> "Success: User \nchanged password"[dir=none];
25		- "Success: User \nchanged password" -> "Sidebar Menu";
	24	+ "Email" -> "Success: User \nchanged password";
	25	+ "Success: User \nchanged password" -> "Navigation Menu";
26	26	}

...	...	@@ -8,11 +8,11 @@
8	8	nodesep=2.5;
9	9	ranksep=0.45;
10	10	"Account Settings"[center=true, fillcolor="#aaaaff", style=filled,pos="0,0!"];
11		- "Account Settings" -> "PATCH /api/me/settings"[dir=none];
	11	+ "Account Settings" -> "PATCH /api/me/settings";
12	12
13	13	"views.update_settings" -> "New settings valid?";
14		- "New settings valid?" -> "Yes\nSUCCESS"[dir=none];
15		- "New settings valid?" -> "No\nFAILURE"[dir=none];
	14	+ "New settings valid?" -> "Yes\nSUCCESS";
	15	+ "New settings valid?" -> "No\nFAILURE";
16	16	"PATCH /api/me/settings" -> "views.update_settings";
17	17	"No\nFAILURE" -> "Account Settings";
18	18	"Yes\nSUCCESS" -> "Save settings";

...	...	@@ -16,9 +16,9 @@
16	16	lp=100;
17	17
18	18	// Graph
19		- "Instructor's Email Client" -> "EMAIL"[dir=none];
	19	+ "Instructor's Email Client" -> "EMAIL";
20	20	"EMAIL" -> "Admin's Message Box";
21		- "Admin's Message Box" -> "MESSAGE"[dir=none];
	21	+ "Admin's Message Box" -> "MESSAGE";
22	22	"MESSAGE" -> "Instructor's Email Client";
23	23	}

...	...	@@ -16,14 +16,14 @@
16	16	"Controller"[center=true, fillcolor="#aaaaff", style=filled, shape=diamond,
17	17	fixedsize=true, width=1.4, height=1.4];
18	18	"POST /api/sections/{pk}/drop"[shape=none];
19		- "Sidebar Menu" -> "POST /api/sections/{pk}/drop"[dir=none];
	19	+ "Sidebar Menu" -> "POST /api/sections/{pk}/drop";
20	20	"POST /api/sections/{pk}/drop" -> "Controller";
21	21	"Controller" -> "User Check";
22	22	"User did not\ndrop class"[shape=none];
23		- "User Check" -> "User did not\ndrop class"[dir=none];
	23	+ "User Check" -> "User did not\ndrop class";
24	24	"User did not\ndrop class" -> "Sidebar Menu";
25	25	"User successfully\ndropped class"[shape=none];
26		- "User Check" -> "User successfully\ndropped class"[dir=none];
	26	+ "User Check" -> "User successfully\ndropped class";
27	27	"User successfully\ndropped class" -> "Sidebar Menu";
28	28	}

...	...	@@ -13,19 +13,19 @@
13	13
14	14	"View Deck" -> "Edit Flashcard Button";
15	15	"Edit Flashcard Button" -> "Flashcard Changes";
16		- "Flashcard Changes" -> "POST /api/flashcards/{pk}"[dir=none];
	16	+ "Flashcard Changes" -> "POST /api/flashcards/{pk}";
17	17	"POST /api/flashcards/{pk}" -> "Controller";
18	18
19	19	//Only blanks(mask) altered
20	20	"Only mask altered"[shape=none];
21	21	"Server creates New FlashcardMask object"[fillcolor="#aaaaff", style=filled,pos="0,0!"];
22		- "Controller" -> "Only mask altered"[dir=none];
	22	+ "Controller" -> "Only mask altered";
23	23	"Only mask altered" -> "Server creates New FlashcardMask object";
24	24	"Server creates New FlashcardMask object" -> "View Deck";
25	25
26	26	//Text changed
27	27	"Text or material date altered"[shape=none];
28		- "Controller" -> "Text or material date altered"[dir=none];
	28	+ "Controller" -> "Text or material date altered";
29	29	"Text or material date altered" -> "Create New Flashcard";
30	30	"Create New Flashcard" -> "Push to Feed";
31	31	"Push to Feed"-> "Add to User Deck";

...	...	@@ -16,9 +16,9 @@
16	16	"Controller"[center=true, fillcolor="#aaaaff", style=filled, shape = diamond,
17	17	fixedsize=true, width=1.4, height=1.4];
18	18
19		- "Feed" -> "Filter"[dir=none];
	19	+ "Feed" -> "Filter";
20	20	"Filter" -> "Controller";
21		- "Controller" -> "Filtered cards"[dir=none];
	21	+ "Controller" -> "Filtered cards";
22	22	"Filtered cards" -> "Feed";
23	23
24	24	}

...	...	@@ -9,10 +9,10 @@
9	9	ranksep=0.1;
10	10	"View Deck"[center=true, fillcolor="#aaaaff", style=filled,pos="0,0!"];
11	11	"View Deck" -> "Edit Flashcard";
12		- "Edit Flashcard" -> "POST /api/flashcard/{pk}/edit"[dir=none];
	12	+ "Edit Flashcard" -> "POST /api/flashcard/{pk}/edit";
13	13	"POST /api/flashcard/{pk}/edit" -> "FlashcardViewSet.edit";
14		- "FlashcardViewSet.edit" -> "Text or material date altered"[dir=none];
15		- "FlashcardViewSet.edit" -> "Only mask altered"[dir=none];
	14	+ "FlashcardViewSet.edit" -> "Text or material date altered";
	15	+ "FlashcardViewSet.edit" -> "Only mask altered";
16	16	"Only mask altered" -> "Update UserFlashcard object";
17	17	"Text or material date altered" -> "Create new Flashcard with prev pointer\nNotify all users who've pulled the card";
18	18	"Only mask altered"[shape=none];
19	19
20	20
...	...	@@ -29,11 +29,11 @@
29	29	"POST"[shape=none];
30	30	"FAILURE"[shape=none];
31	31	"SUCCESS"[shape=none];
32		- "Sidebar Menu" -> "POST"[dir=none];
	32	+ "Sidebar Menu" -> "POST";
33	33	"POST" -> "Controller";
34		- "Controller" -> "FAILURE"[dir=none];
	34	+ "Controller" -> "FAILURE";
35	35	"FAILURE" -> "Sidebar Menu";
36		- "Controller" -> "SUCCESS"[dir=none];
	36	+ "Controller" -> "SUCCESS";
37	37	"SUCCESS"->"WhiteListCheck";
38	38	"WhiteListCheck" -> "Permission Denied: \n User cannot be enrolled in class";
39	39	"WhiteListCheck" -> "Success! \n User is added to class";

...	...	@@ -24,13 +24,13 @@
24	24	"Flashcard Hidden from Feed"[center=true, fillcolor="#aaaaff", style=filled];
25	25	"POST /api/flashcards/{pk]/report"[shape=none];
26	26	"Live Feed" -> "Flag as Inappropriate";
27		- "Flag as Inappropriate" -> "POST /api/flashcards/{pk]/report"[dir=none];
	27	+ "Flag as Inappropriate" -> "POST /api/flashcards/{pk]/report";
28	28	"POST /api/flashcards/{pk]/report" -> "Controller";
29		- "Controller" -> "FAILURE"[dir=none];
	29	+ "Controller" -> "FAILURE";
30	30	"FAILURE" -> "Live Feed";
31		- "Controller" -> "POST /api/flashcards/{pk]/report"[dir=none];
	31	+ "Controller" -> "POST /api/flashcards/{pk]/report";
32	32	"POST /api/flashcards/{pk]/report" -> "Server";
33		- "Server"-> "SUCCESS"[dir=none];
	33	+ "Server"-> "SUCCESS";
34	34	"SUCCESS" -> "Flashcard Hidden from Feed";
35	35	"Flashcard Hidden from Feed" -> "Server creates a FlashcardReport object";
36	36	"Server creates a FlashcardReport object" -> "Live Feed";

...	...	@@ -17,10 +17,10 @@
17	17
18	18	"Controller"[center=true, fillcolor="#aaaaff", style=filled, shape = diamond,
19	19	fixedsize=true, width=1.4, height=1.4];
20		- "Feed" -> "POST"[dir=none];
	20	+ "Feed" -> "POST";
21	21	"POST" -> "Controller";
22		- "Controller" -> "FAILURE: card no longer\nexists in database"[dir=none];
23		- "Controller" -> "SUCCESS: card\nsuccessfully hidden"[dir=none];
	22	+ "Controller" -> "FAILURE: card no longer\nexists in database";
	23	+ "Controller" -> "SUCCESS: card\nsuccessfully hidden";
24	24	"FAILURE: card no longer\nexists in database" -> "Feed";
25	25	"SUCCESS: card\nsuccessfully hidden" -> "Feed";
26	26	}