Code-dot-mil/code.mil

Allow Project Owners to submit projects for code inventory file

Open

#231 opened on Jul 10, 2018

View on GitHub
 (0 comments) (0 reactions) (2 assignees)JavaScript (1,238 stars) (115 forks)batch import
[effort] large[issue-type] enhancement[skill-level] advancedcode.govhelp wantedwebsite

Description

We should consider creating a form on the code.mil website that allows project owners to submit details of their projects for the purposes of generating the code.json inventory file.

The steps toward this goal might involve…

  • breaking the existing code.json file into project-specific data files (e.g. src/_data/code_json/move-mil.json (or YAML…?) (#232)
  • add small Jekyll plugin to generate code.json file from data files (#232)
  • determine a means of validating individual project data files and the resultant code.json file
  • create the necessary pages on code.mil website to accept these submissions (this one's worth its own issue for sorting out design, implementation, etc.)
  • form submission could/should create a pull request on this project's repository for evaluation and inform the user of the PR's URL (on say, a "thanks!" page)

Possibly useful Netlify documentation:

Contributor guide

Tech stack
javascripthtmlcssrubynetlify
Domain
full stackapi
Issue type
feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
3-5 days
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
mostly clear
Prerequisites
JekyllNetlifyJavaScriptGitHub API
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
25
Research direction
The remaining tasks include validating individual project data files (likely in src/ data/code json/) and the resulting code.json, creating submission pages on the code.mil site, and implementing form submission to create a pull request. Look at the existing Netlify form handling docs and consider using Netlify Functions to process form submissions and interact with the GitHub API to create PRs. The first two steps are already completed, so focus on the validation logic and the form UI. Check comments for any additional guidance from maintainers.
Allow Project Owners to submit projects for code inventory file · Code-dot-mil/code.mil#231 | Good First Issue