18F
GUI for about.yml create/edit
In order for me as a project lead or product owner to feel confident that my edits to the about.yml file will look right, or contain the correct information on the dashboard, I should be able to preview how the data will look on the dashboard before I merge my changes.
Acceptance criteria: I am a product owner or product lead I've edited the about.yml file for my project I'm on a branch and have not merged my changes I should be able to somehow preview how my project would actually appear in the dashboard given my changes And if I'm happy with the changes I should be able to merge my changes, and when live, my project should look the same as it did in the preview.
Notes: We should make sure that this preview tool serves as an actual preview as much as possible. We should be using the latest dashboard code as well as the latest Team API code.
https://18f.mybalsamiq.com/projects/aboutymlpreviewtool/Dashboard%20Preview
Based on our meeting... a potential approach/option would be to use the about.yml json schema coupled with https://github.com/JJediny/json-editor which builds a UI form based on that schema...
You can test it out by pasting the current schema into the Schema block on this test deployment which I used grunt (could swap for gulp) to compile/host the build onto gh-pages: http://jjediny.github.io/json-editor/
There are tons of JS libraries to convert json output to yaml... also consider:
- [ ] Issuing a UUID as a stable identifier to combat moving repos/forks and cross referencing parent/child relationship... https://github.com/jdorn/json-editor/pull/535
- [ ] Adding a
save to gistbutton to drop the DOM into github where it could then be placed in the target repo
