Beginning of External Event documentation #183
Conversation
|
Please make the plan collaboration docs about external events link back to the main external events docs. |
JosephVolosin
force-pushed
the
external-events-docs
branch
2 times, most recently
from
690d128 to
9fbc6ac
Compare
Co-authored-by: psubram3 <[email protected]>
JosephVolosin
force-pushed
the
external-events-docs
branch
from
9fbc6ac to
68deff7
Compare
There was a problem hiding this comment.
Mind updating this screenshot to latest?
There was a problem hiding this comment.
Not a blocker but would be nice to update this screenshot as well
docs/planning/external-events.mdx
Outdated
| } | ||
| ``` | ||
|
|
||
| *Note: Currently, External Sources only accept a `start_time` and an `end_time`, whereas External Events accept only a `start_time` and a `duration`. This may change in the future (i.e. External Events may accept a start time and an end time as well, for example). This is largely due to simplicity in implementation.* |
There was a problem hiding this comment.
This should be one of Info blocks (with the header Note)
docs/planning/external-events.mdx
Outdated
| External Sources are containers for External Events and the primary way that users interact with External Events. To get External Events into Aerie, an External Source must be uploaded that contains the event definitions inside. See [External Sources](#external-sources-1) below for more information. | ||
|
|
||
| #### External Event Types | ||
| External Event Types define the *typing* of each External Event. This typing typically groups External Events on the basis of the data they represent. For example, an External Event may be of the type `Ground Station Contact`, `Solar Flare`, or `Weather Forecast`. |
There was a problem hiding this comment.
Remove the wordtypically from here and L51. There isn't a meaningful instance where the rest of the sentence wouldn't apply, and this becomes more true as we add more metadata columns to the types.
|
|
||
| <figure> | ||
| <img alt="External Sources pane with no associations, but showing a card with 'new' External Sources" src={externalEventsTutorialExternalSourcesEmpty} /> | ||
| </figure> |
There was a problem hiding this comment.
In my testing on the final merged version, the "new file has been uploaded" notification does not appear in this case. I think we changed the behavior here late in the review process to only show this for sources which actually affect the plan - ie. are tied to derivation groups already associated with the plan. I'll change the wording here a bit to reflect this and upload a new screenshot.
The notification did correctly appear when I added a new source to this group after it was already associated with the plan.
|
|
||
| External events appear in the same layer type as activities, and as such share options with them inside of the timeline row editor. | ||
|
|
||
| There is a single option that is specific to external events: `Group By`. This allows the user to display the external events either as being grouped underneath the their respective external sources, or grouped underneath their respective external event types. |
There was a problem hiding this comment.
For some reason when an external events row is added via the method in this tutorial, the "Group By" option does not appear in the Timeline Editor as expected. I think this is a bug, because it does appear in the automatically generated External Events row that shows up if you refresh the page. It's not a showstopper bug, but I'm going to comment out the paragraphs that mention "group by" here to avoid confusion & @JosephVolosin we can look into this for a follow up fix.
…s, temporarily comment out references to Group By for EE rows in Timeline Editor
This pull-request adds documentation for the external event feature being currently worked into Aerie. See the following pull-requests below for more information on the feature:
NASA-AMMOS/aerie#1513
NASA-AMMOS/aerie-ui#1396