Design Research Projects Epic

[Legonois]

User Story

As a Developer, I want to be able to organize and track the progress on the Research Projects system as a collection of User Stories

Description

We need to be able to take feedback and fully define the system that we will use to create Research Projects and User Stories

Tasks

• [x] Design (Research Projects) object
• [ ] Review (Research Projects) object
• [ ] Create user stories
• [ ] Get feature feedback on user stories
• [ ] Review with team

[Legonois]

Research Project Object Design

Properties

• Title

  • Ex. Topical Knowledge Map
  • Requirements
  • Alphanumeric characters and spaces only
  • Max length of 50

• Research Category

  • Ex. Natural Language Processing, Reinforcement Learning, etc.
  • The category of research the project is under
  • Requirements
  • Integrates with Research Category Table

• Description

  • A detailed description of the research project
  • Requirements
  • Max length of 2000 characters
  • Enforces MDX

• Tags

  • Keywords or topics related to the research project
  • Requirements
  • Integrates with Tags Table

• Personnel

  • A list of people involved in the research project
  • Requirements
  • Integrates with Personnel/Member/User Table
  • Name
  • Role (e.g., Principal Investigator, Research Assistant, etc.)
  • Email
  • Affiliation

• Publications

  • A list of publications related to the research project
  • Requirements
  • Integrates with Publications Table

• Datasets

  • A list of datasets user or generated in the research project
  • Requirements
  • Name
  • Description
  • Source URL
  • Privacy (public or private)

• Source Code

  • Information about the source code repository for the research project
  • Requirements
  • URL
  • Privacy

• Funding

  • Information about the funding source for the research project
  • Requirements:
  • Source
  • Award Number
  • Award Amount
  • Date Awarded

Questions

• Do we need a funding object?
  • [Response]
• Should Source Code be a top level property?
  • [Response]
• What length constraints should we have for the Description and Methodology? (if any?)
  • [Response]

Required Object Tables

1. ResearchProjects
2. Publications
3. Datasets
4. Source Code (?)
5. User / Member
6. Tags
7. EntityTags
8. PersonellProject

Reviewers

• [x] Wesley
• [ ] Tatenda
• [x] Rob

[Legonois]

Implemented a MDX parser as apart of this feature, as the Research Projects will support MDX https://mdxjs.com/packages/remark-mdx/

060385c5e658fb65e11defdf929b2101b5b0e686

[Legonois]

Things we discussed:

Navigation Whiteboard

How navigation will work! I think we came to the conclusion of creating a few things.

I will also be lowering the scope of this project item. This will SOLEY be about the research project design work, not including the implementation side of it. Hopefully will be easier to digest and we can get though this faster

[Legonois]

Removed - [ ] Review with Dr. Hsu - [ ] Create issues based on user stories - [ ] Review (Research Projects) object - [ ] Look into https://github.com/typeorm/typeorm for table creation - [ ] Create Research Projects table

[Legonois]

User Stories

Backend

• Design Research Project Dependencies
• Create Research Projects Object
• Design Category Object
• Create Category Object
• Navigation System

Frontend

• Navigation Bar
• Display Page