Getting Started - SUNYORIED/rdaf GitHub Wiki

• Click an RDaF Stage to expand and see the RDaF Topics associated with that stage.
  • Hover your mouse over the Stage to see the description of that stage from the RDaF
• Click an RDaF Topic to see the Outcomes SUNY has defined as extensions of that Topic's Subtopics
  • Hover your mouse over the Outcomes button to see the RDaF Topic description
• Score an individual Outcomes as either Not Started or In Progress will expand the model to show proposed Activities and related elements.
  • Hover your mouse over the RDaF Subtopic on an Outcome or Activity to see the details of the RDaF subtopic that Outcome or Activity extends.
• Click on the "Considerations" button for an Outcome or an Activity to expand a list of RDaF subtopics which SUNY classified as considerations for the topic (as opposed to Activities or Outcomes).
• Click on the "Activities" button to expand the Activities SUNY identified as being necessary to produce the Outcome. Each Activity may have Methods, Roles, Participants, Resources, Outputs or Considerations which can be expanded.
• Use the "Download Scores" button to download a CSV file of Outcome scores
• Use the "Reset Scores" button to reset all of the scores on all Outcomes
• See the Prototype Data Model for further details on SUNY's interpretation of the RDaF.
• See the User Stories for further details on the motivation behind this tool.

If you want to implement your own version of the data model, or suggest changes to SUNY's mapping of the RDaF, the simplest way to do this is to:

1. make a fork of the repository
2. publish the tool as a webpage using the GitHub Pages feature
3. edit the mappings in the graph.jsonld file
4. test your changes
5. submit a pull request to the SUNY repository to share your changes back (optional)

Instructions for each of these steps are provided below.

1. On GitHub.com, navigate to this repository (https://github.com/SUNYORIED/rdaf).
2. In the top-right corner of the page, click Fork.
   
3. Under "Owner," select the dropdown menu and click an owner for the forked repository. (This will normally be your GitHub user account name)
4. By default, the fork will be named 'rdaf', the same as this repository. You can change this if you want by supplying your own name, in the "Repository name" field.
5. Click Create fork
6. A copy of the repository will now be available in your GitHub account.

1. On GitHub.com, navigate to your fork of the repository.
2. Under your repository name, click Settings. If you cannot see the "Settings" tab, select the dropdown menu, then click Settings.
3. In the "Code and automation" section of the sidebar, click Pages.
4. Under "Build and deployment", under "Source", select Deploy from a branch.
5. Under "Build and deployment", use the branch dropdown menu and select a publishing source. Choose "main" to deploy from the main branch.
6. Use the root directory.
7. Click Save.
8. After a few minutes, the page should be available at https://.github.io/. (For example, if your github account name is 'octocat' and you kept the default repository name of 'rdaf' when you forked it, the tool should load at https://octocat.github.io/rdaf)
9. Any changes you make in the main branch of your repository will be automatically published to this page.

The graph.jsonld file contains all of data that is displayed in the tool. This file must parse as a valid JSON-LD file in order for the tool to work properly. For a full guide to working with JSON-LD data, please refer to JSON-LD Guide. This site also contains tools you can use to validate that a JSON-LD file is valid. The instructions below provide guidance on how to use GitHub to edit the graph.jsonld file but a full explanation of the syntax of JSON-LD is out of scope for this guide.

See also the Prototype Data Model for further details on the schema used.

• Edit the JSON-LD graph and commit the changes to your own repository.

1. In your own fork of the repository, browse to the graph.jsonld file. Path: (rdaf/data/jsonld/graph.jsonld).
   
2. In the upper right corner of the file view, click to open the file editor. Note: Instead of editing and committing the file using the default file editor, you can optionally choose to use the github.dev code editor by selecting the dropdown menu and clicking github.dev. You can also clone the repository and edit the file locally via GitHub Desktop by clicking GitHub Desktop.
   
3. In the text box, make any changes you need to the file.
4. Above the new content, click Preview.
5. Click Commit changes...
6. In the "Commit message" field, type a short, meaningful commit message that describes the change you made to the file.
7. If you have more than one email address associated with your account on GitHub.com, click the email address drop-down menu and select the email address to use as the Git author email address. Only verified email addresses appear in this drop-down menu. If you enabled email address privacy, then a no-reply will be the default commit author email address. For more information about the exact form the no-reply email address can take, see "Setting your commit email address."
8. Below the commit message fields, decide whether to add your commit to the current branch or to a new branch. The simplest approach is to commit directly to your current branch. (Note GitHub best practices for collaborating on code suggest using a separate branch. A full explanation of this is out of the scope for this guide but for more information, see "Creating a pull request.")
9. Click Commit changes

If you want to submit changes you have made in your own repository back to the source SUNYORIED rdaf repository for consideration for inclusion, you should issue a Pull request.