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

Use prose.io for friendlier github editing #192

Open
patcon opened this issue Jan 21, 2018 · 1 comment
Open

Use prose.io for friendlier github editing #192

patcon opened this issue Jan 21, 2018 · 1 comment

Comments

@patcon
Copy link
Contributor

patcon commented Jan 21, 2018

Hi again!

I see that you currently link each page in https://doc.highfidelity.com to the github page in the grav content repo. This is awesome!

Having said that, I wonder whether prose.io might better serve you. It's an alternative to the github edit interface, designed by a well-respected web dev agency called "Development Seed". This company wanted to a build on GitHub Pages, but didn't want to force non-technical users to wade through coder lingo. Its a little less value-add these days, as github has done a whole lot to improve the PR creation workflow, but it's still nice.

Prose.io is technically a really thin GitHub Pages app itself, totally open source -- it just uses a really slim authentication proxy to coordinate the oauth dance with github, but is otherwise stateless and just runs off github api. And fwiw, "Development Seed" are the creators of "MapBox", and they're a stable force imho.

So instead of linking to GitHub's edit page, you'd just link here:
http://prose.io/#highfidelity/hifi-docs-grav-content/blob/master/01.get-started/01.what-is-high-fidelity/docs.md

or here maybe:
http://prose.io/#highfidelity/hifi-docs-grav-content/edit/master/01.get-started/01.what-is-high-fidelity/docs.md

This is how it looks when submitting (ie. absolutely no github once you login):
https://imgur.com/dVw9jfX

And here's the generated PR:
#191

@nimisha20
Copy link
Contributor

That is an interesting solution! I have to look into how much time would go into implementing that and if it would be approved by our teams.

It certainly would make it less daunting to contributors who are not comfortable using GitHub.

Thanks for this suggestion - I will look into it!

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