search

mozilla / gud

Mozilla Growth & Usage Dashboard, pronounced "Good"
https://gud.telemetry.mozilla.org
3 stars 4 forks source link

Move GUD docs into repository from dtmo #86

Closed wlach closed 4 years ago

wlach commented 4 years ago

See also: https://bugzilla.mozilla.org/show_bug.cgi?id=1647872

Here's a preview of what it looks like: https://wlach.github.io/gud/

I updated some link references, but otherwise tried to keep the content changes to a minimum. I'd prefer to leave any editorial changes for you to do in a followup. 😄

wlach commented 4 years ago

Feels like there could be a standard for some of these data apps to have their documentation live in GH. Do you think this is a reasonable pattern going forward?

I think so, Jekyll is not too difficult to set up, markdown is easy/fun to write at least for technically inclined people, and the results look pretty good IMO. I think for the earlier stages of a project (when things are constantly changing and looking 100% polished may not even be desirable) a Google Doc as you used is likely a better approach.

robhudson commented 4 years ago

Feels like there could be a standard for some of these data apps to have their documentation live in GH. Do you think this is a reasonable pattern going forward?

Yeah, github pages can do a static deploy of just a docs/ folder for this reason, I imagine: https://github.blog/2016-08-22-publish-your-project-documentation-with-github-pages/

wlach commented 4 years ago

Looks good; thanks for doing this!

Curious: looks like the docs page will be GA-tracked? Will that be the same config as the rest of GUD?

This isn't configured but should be relatively easy to set up with Jekyll. I'm not sure how it would work given that the docs would be on mozilla.github.io/gud and gud would be at... whatever it's URL winds up being. :) Apparently it is possible to configure GA to track "linked" visits: https://support.google.com/analytics/answer/1034342?hl=en