Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Dataset description should support markdown and long-form #33

Open
JJediny opened this issue Mar 24, 2016 · 4 comments
Open

Dataset description should support markdown and long-form #33

JJediny opened this issue Mar 24, 2016 · 4 comments

Comments

@JJediny
Copy link
Contributor

JJediny commented Mar 24, 2016

Some datasets may need more description and some potential forks could require tweeting the yaml content...

Consider adding a markdown editor to the edit form, the output of which could be combined with the yaml as a single payload to github for the commit:

yaml + --- + markdown === dataset.md --> Github API

Instead of using a hard coded JS web form, we've been considering using a webform that gets generated from a json schema whose output is yaml. This would allow projects/programs with their own established standards or using a common standard like data.json to be the yml model.

@timwis
Copy link
Owner

timwis commented Mar 24, 2016

  1. Interesting idea, and I can definitely see the merit in it. That's a nice editor, too. Thanks for the suggestion, definitely sounds doable.
  2. Hah, it sounds like we're thinking about the same things. I posted this idea in prose.io's repo a couple weeks ago that sounds pretty similar. This project was what got me thinking of that, but I later got the idea to just build something specific for this project (the HTML form), which would be a bit easier for non-technical users, but less generic/universal like what you mentioned. Definitely interested in the idea though, happy to chat more about it and work on it with you.

@timwis timwis changed the title Alternative approach to consider for editting datasets Dataset description should support markdown and long-form Mar 28, 2016
@timwis
Copy link
Owner

timwis commented Mar 28, 2016

Hope it's okay that I've changed the title. Let's chat about your second idea verbally this week.

@JJediny JJediny mentioned this issue Mar 31, 2016
3 tasks
@JJediny
Copy link
Contributor Author

JJediny commented Apr 7, 2016

20160407_151301
Whiteboarding session with @philipashlock

Blue == Current JKAN form/workflow
Red == Proposed JSON schema based editor/workflow
Green == Questions/Issues outstanding also related to Issue #62

@timwis
Copy link
Owner

timwis commented Apr 9, 2016

Woah - that looks like some great ideas put on a whiteboard, but I feel like I might be less equipped to understand it without the narrative that assumedly accompanied it. Perhaps you can walk us through it a bit?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants