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

Put the "edit this page on GitHub" button on each usermanual page #56

Open
jakub-g opened this issue Jan 29, 2014 · 2 comments
Open

Put the "edit this page on GitHub" button on each usermanual page #56

jakub-g opened this issue Jan 29, 2014 · 2 comments

Comments

@jakub-g
Copy link
Collaborator

jakub-g commented Jan 29, 2014

On Karma, and many other projects, there's a direct link to edit the documentation page you're looking at right now, directly on Github (top right):

http://karma-runner.github.io/0.10/config/browsers.html

This would be a great opportunity to minimize the effort for people to contribute to the documentation.

However it's not that simple do this kind of thing on our side now, because the URLs in usermanual and github repo do not match: the URLs are flat on AT.com

//ariatemplates.com/usermanual/latest/ working_in_an_asynchronous_world

while they're structured in the repo:

//github.com/ariatemplates/usermanual/blob/master/src/latest/ core/concepts/working_in_an_asynchronous_world .md

(honestly I don't like this discrepancy, I don't have a preference, but it should be consistent)

However if we don't want to change the structure, in order to implement the feature, we could embed the "github classpath" in each MD file (via JS variable maybe and then make a script which will read it and put a DOM element with a link, or make it build-time, whatever is easier to do).

@jakub-g
Copy link
Collaborator Author

jakub-g commented Jan 29, 2014

Regarding contributing documentation from external people:
we have a link on the bottom of AT.com (CONTRIBUTE > Documentation) which leads to:
http://ariatemplates.com/contribute/documentation :)

@jakub-g
Copy link
Collaborator Author

jakub-g commented Mar 14, 2014

I added the link "open an issue on github" in efdbbb5 in the bottom of documentation entries, but I still think "edit this on github" would be even better :)

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

No branches or pull requests

1 participant