search

daveaglick / discoverdotnet

A web site that helps you discover awesome .NET open source and community resources
https://discoverdot.net
MIT License
303 stars 254 forks source link

Improve submission workflow #8

Open daveaglick opened 6 years ago

daveaglick commented 6 years ago

Either use something like staticman.net or pre-populate a GitHub PR from form data.

daveaglick commented 6 years ago

Done

StephenCleary commented 6 years ago

Is there any reason staticman wasn't used? It would take away a few steps to submit resources, which may increase submissions.

First-time experience right now looks like:

It's just a lot of clicks. And that's assuming I'm already logged into GH. With Staticman, it would just be the first step. Disadvantage of Staticman would be that you don't know who submitted what.

daveaglick commented 6 years ago

Disadvantage of Staticman would be that you don't know who submitted what.

That's basically the reason. I wanted contributors to both get credit for their contributions and be able to reach out for clarifications or more detail if needed. I considered using Staticman with an extra field for submitter email or something, but then I'd need to strip that out in the final submission.

I also looked at using Netlify forms which puts the submissions behind an API. That would need a little extra tooling to convert those back to YAML files in the repo though. Or I could have had the generator pull straight from the Netlify API for data, but then it's invisible and the "Edit This Entry" workflow doesn't work.

Long-term I've thought about using the GitHub API via JavaScript to basically get down to that first step for folks who already have GitHub accounts and are logged in. That would probably require a one-time OAuth approval, but would be a better flow after that for repeated submissions.

Now that you've gotten me to put my thinking cap on and write a bazzilion words on it :smile:, I'll re-open this issue as a generic "improve the submission flow".

daveaglick commented 6 years ago

One other thing we could do is pre-populate the file name based on the title or other fields. That should cut it down to a single GitHub submission click if the default fork/branch is accepted.

StephenCleary commented 6 years ago

That's a good idea. slugify may be useful there.