Story Configuration

Configuring a Story that references Datasets in your Dashboard

By this point, you should have a few things:

  1. A draft of a story that you want to show in VEDA
  2. Necessary datasets available in your VEDA STAC, and ideally with a dataset overview page already configured in your Dashboard
  3. Images, csv files, or any other supporting assets prepared

πŸ§‘β€πŸ« We recommend you follow the video walkthrough on how to setup a virtual environment to facilitate story creation.

Key Steps

Key steps for configuring a story in your VEDA Dashboard are very similar to configuring a dataset overview page, outlined again below.

  1. Go to the veda-config repo in GitHub

  2. If using a local environment:

    1. Familiarize yourself with the Setup and Configuration sections of the documentation

    2. Using your local environment, create a branch for your story

    3. Following the guidelines outlined in the Content section of the VEDA UI documentation, create your Story MDX file

    4. Add relevant files and assets as needed

    5. Push your branch and create a pull request in GitHub

  3. If configuring through GitHub

    1. Following the guidelines outlined in the Content section of the VEDA UI documentation, create your Story MDX file and add it to a new branch on GitHub.

    2. Add relevant files and assets as needed

    3. Commit your changes and open a Pull Request

  4. Once the pull request is created, you will be able to see a preview of the story in a Netlify box under the Conversation tab of the pull request

    πŸ€ You don’t have to fully finish your story all in one go. Every time you make a commit the preview will be regenerated with your changes (takes about 3 minutes).

  5. Once you feel good about the story, add the necessary team members and stakeholders to review the story

  6. Paste a comment in the pull request with any additional information, such as any goal dates for publishing this story or any outstanding questions you have

  7. Once the pull request is merged, the files will still need to be pushed to production. Coordinate with your development team and managers to determine the release date.

Video Walkthrough

Setting up GitHub codespaces

Codespaces will allow you to have a development environment in the cloud without the need to setup anything on your local machine. VIDEO

Creating a story

Walkthrough of how to use GitHub codespaces to create a story. From creating the needed files to the Pull Request that will eventually get the content published. VIDEO

If you have any questions along the way, we prefer that you open tickets in veda-config. Alternatively, you can reach the VEDA team at veda@uah.edu.