search

airbnb / knowledge-repo

A next-generation curated knowledge sharing platform for data scientists and other technical professions.
Apache License 2.0
5.48k stars 687 forks source link

Feature Request: Form Based Posts #156

Open koaning opened 7 years ago

koaning commented 7 years ago

Auto-reviewers: @NiharikaRay @matthewwardrop @earthmancash @danfrankj

I don't know if this is the right place for this. But after showing this project to a few clients there seemed to be an unexpected feature missing before folks wanted to invest in this project.

This project is interesting because it offers a standardised method to share data science documents in an open blog kind of format. Turns out that this is only half the use-case for most of my clients. People seem to want to be able to fill in a standardised form too.

Reason for this that usually company X does a lot of AB tests and they are looking for a nice way to be able to store these results and share them. These AB tests are usually very standardised to such a degree that a form based UI would make sense to submit results. An RMD/Notebook could also do this, but offers maybe a bit too much freedom and might require a lot of overhead in checking up. If this were added I think the in-company adoption rate of this project would be much higher because you'll have effectively lowered the bar of entry. (Many analysts who use SQL aren't used to git/command line).

danfrankj commented 7 years ago

Howdy @koaning

These are great thoughts - responses below

re: git We also have researchers who do not use git and have developed web-based contribution flow which if enabled for your repository allows users to add posts and they only need to know markdown ( image I'll be writing up some more documentation on this feature soon - do you think this feature fits your needs?

re: post structure Even though the web editor allows users to submit without knowing git, they can still submit anything they can write up in markdown. We don't support post templates right now but that could be added. We welcome contributions :) In the meantime it might make sense to store the template (the template could be a knowledge post itself!) and ask analysts to use it?

koaning commented 7 years ago

So the form looks fine, but preferably the knowledge repo has a method to design a custom form for a certain team. I'll try to see if I can find a nice way to add that. fingers crossed.