Details
-
Type:
Task
-
Status: Closed (View Workflow)
-
Priority:
Major
-
Resolution: Done
-
Affects Version/s: None
-
Fix Version/s: None
-
Labels:None
-
Story Points:1
-
Epic Link:
-
Sprint:Fall 1 2021 Aug 16 - Aug 27
Description
I think maybe Figure 1 - the architecture diagram - needs revision.
The client / server dividing line is a bit confusing. IGB is show on the server side of the dividing line, which does not make sense to me because IGB is not a client-side program. Similarly, "template" is on the client side of the dividing line, but Django templates are entirely server-side. That's the entire point of them, I thought - they are never exposed to the Web browser.
The meaning of the two boxes on the server side is also confusing. Are those boxes meant to make the figure look nicer, or do they have a meaning with respect to the architecture?
Attachments
Activity
| Field | Original Value | New Value |
|---|---|---|
| Epic Link |
|
| Assignee | Karthik Raveendran [ karthik ] | Ann Loraine [ aloraine ] |
| Status | To-Do [ 10305 ] | In Progress [ 3 ] |
| Status | In Progress [ 3 ] | Needs 1st Level Review [ 10005 ] |
| Description |
I think maybe Figure 1 - the architecture diagram - needs revision. At the very least, there needs to be a narrative explaining what it means.
The client / server dividing line is very very confusing. IGB is show on the server side of the dividing line, which does not make sense to me because IGB is not a client-side program. Similarly, "template" is on the client side of the dividing line, but Django templates are entirely server-side. That's the entire point of them, I thought - they are never exposed to the Web browser. The meaning of the two boxes on the server side is also confusing. Are those boxes meant to make the figure look nicer, or do they have a meaning with respect to the architecture? Please provide a detailed legend for the figure, explaining what each part represents. If you try to put into words what the pictures mean, you will likely be able to think of ways to make the image more clear. |
I think maybe Figure 1 - the architecture diagram - needs revision.
The client / server dividing line is a bit confusing. IGB is show on the server side of the dividing line, which does not make sense to me because IGB is not a client-side program. Similarly, "template" is on the client side of the dividing line, but Django templates are entirely server-side. That's the entire point of them, I thought - they are never exposed to the Web browser. The meaning of the two boxes on the server side is also confusing. Are those boxes meant to make the figure look nicer, or do they have a meaning with respect to the architecture? |
| Attachment | Figure1.png [ 16780 ] |
| Assignee | Ann Loraine [ aloraine ] |
| Status | Needs 1st Level Review [ 10005 ] | First Level Review in Progress [ 10301 ] |
| Status | First Level Review in Progress [ 10301 ] | Ready for Pull Request [ 10304 ] |
| Status | Ready for Pull Request [ 10304 ] | Pull Request Submitted [ 10101 ] |
| Status | Pull Request Submitted [ 10101 ] | Reviewing Pull Request [ 10303 ] |
| Status | Reviewing Pull Request [ 10303 ] | Merged Needs Testing [ 10002 ] |
| Status | Merged Needs Testing [ 10002 ] | Post-merge Testing In Progress [ 10003 ] |
| Resolution | Done [ 10000 ] | |
| Status | Post-merge Testing In Progress [ 10003 ] | Closed [ 6 ] |
| Assignee | Ann Loraine [ aloraine ] |
| Assignee | Ann Loraine [ aloraine ] |
| Assignee | Ann Loraine [ aloraine ] |
Previous version
| Attachment | 1.jpg [ 16781 ] |
Note: If reviewers ask, we can further improve the figure for clarity.
Made a new version, which I hope is better. It is attached.