Details
-
Document
-
Resolution: Done
-
Major
-
None
-
None
-
None
Description
Improve the linking between the various pages in the model reference section of the site. There are people that don't realize there's more information at schema.ed-fi.org, and that contains a bunch of additional detail.
Here's the slack convo that spawned this:
@skerlick-edfi @chris.moffatt "Unifying Data Model - v3.1 Model Reference" https://techdocs.ed-fi.org/display/EFDS31/Enrollment+-+UDM+v3.1 page makes it seem like it's all the documentation for the UDM, but it doesn't have the data that's in the Schema. (like http://schema.ed-fi.org/datahandbook-v31/Ed-Fi-UDM-Handbook-Index.html#/StudentSchoolAssociation613 ) Do you think it's worth modifying the Model Reference to point people to the schema, so we don't have the same problem Patrick (and I) both had? (edited)
skerlick-edfi 12:06 PM
Do you mean by inserting hyperlink to the API Docs and schema docs?
chris.moffatt 12:27 PM
@Zack good point. A link to the schema documentation is referenced with the TechDocs info (e.g. right panel on https://techdocs.ed-fi.org/display/EFDS31/Ed-Fi+Unifying+Data+Model) , but we should look at embedding it in a more contextual manner. Please open a ticket in the Data Standard project (https://tracker.ed-fi.org/projects/DATASTD) - so @eric.jansson can follow up
Zack 12:29 PM
@skerlick-edfi Idk exactly, but you get to the UDM model reference, and it's easy to think that's the end of the documentation
Zack 12:50 PM
So some kind of fix so that when you're on the UDM page, you know to go to the schema page for even more detail. I'd forgotten about it, and I know a lot of people end up linking to the UDM page, and don't see more detail. I figure if I've forgotten about the separate schema site more then once, others might not even know about it.
skerlick-edfi 12:56 PM
Yes, @Zack please open a ticket as Chris mentioned to add that inline ("For more detail ->" sort of thing)