Uploaded image for project: 'Ed-Fi Data Standard'
  1. Ed-Fi Data Standard
  2. DATASTD-1605

Data Standard Early Access version documentation feedback

    XMLWordPrintable

Details

    • Task
    • Resolution: Done
    • Major
    • None
    • None
    • Data General Upkeep
    • None

    Description

      The Data Standard documentation between early access and the final version is confusing and challenging to navigate.

      Currently, the same space and pages are used to document the versions, so if someone starts looking at an early version it is hard to find the right information with basic tool knowledge.

      1. JIRA: The link to the ticket query based on the Jira release version only shows the latest, for example in v3.2 that link includes all early access versions a,b,c so a user has to know how to build or edit the query to only see items added on an early version to understand the progression.  

      2.GitHub shows all the file changes, tech folks would need to get involved to do a comparison between tags. Not very usable for business users.

      3. In Techdocs you can see previous versions, but users would have to know to go to the page properties which is unlikely they will know how to do this.

      A suggestion would be to have sub-sections for the early access version under the What's new page. It is beneficial to see the progression from early access to the final version on the page without having to dig into the code or tickets. Makes sense that the "What's new" section shows whatever was added/removed from previous early access and a clear list of what was done during what early release version.

      Attachments

        Issue Links

          Activity

            People

              Unassigned Unassigned
              Itzel.Torres Itzel Torres [Contractor] [X] (Inactive)
              Votes:
              0 Vote for this issue
              Watchers:
              3 Start watching this issue

              Dates

                Created:
                Updated:
                Resolved:

                Salesforce