Updating README.md with a couple of n00b Q & As about octohatrack

[glasnt]

Hi @KirstieJane! Thank you for taking the time to describe the issues you're having.

Yay a windows installation! I hadn't tested it on a Windows box before, but I'm glad it all worked.

I have been lax and I haven't updated the documentation, and for that I apologise. Once I release the new 0.4 version, I'll be updating the documentation to show that you don't need any flags to run the report.

On the point of --generate-html - we have https://labhr.github.io/js-hatrack/ which is a web-based version of the HTML reporting, which includes such wonderful features as being faster and prettier than the Python-generated HTML. Once it's got the same features as the Python version, I'll be removing the HTML generation from the published version of the package.

If you want to try out the https://labhr.github.io/js-hatrack/ app and see how it works for you as something you can reload when required, as opposed to having to download and re-run periodically.

[KirstieJane]

Ah! How fun is that link?! I love it! Even better :)

Happy to do any user testing on Windows if necessary going forwards but I think you've already made the tool I'm looking for!

[KirstieJane]

Oh - hang on - is it possible to have a link from https://labhr.github.io/js-hatrack/ that doesn't require one to be logged into GitHub?

[glasnt]

Unfortunately not - unless you're authenticated, you don't get enough API
tokens to complete the report.

If you run the command line app without authentication, you get an explicit
warning about this.

I hope this isn't a blocker for you.

Unrelated - Can I ask which repo you're running these reports on?
On Mar 17, 2016 7:13 AM, "Kirstie Whitaker" [email protected]
wrote:

Oh - hang on - is it possible to have a link from
https://labhr.github.io/js-hatrack/ that doesn't require one to be logged
into GitHub?

—
You are receiving this because you commented.
Reply to this email directly or view it on GitHub
#75 (comment)

[KirstieJane]

Gotcha. We'll figure out a combo of the static html from the command line tool and the fabulous interactive link. And on that note, does this work for you? https://labhr.github.io/js-hatrack/#repo=kirstiejane/Stemmrolemodels

The repo is https://github.com/KirstieJane/STEMMRoleModels

We're very early on but a major goal is to build a really positive community. And this way of saying thank you is excellent :)

[glasnt]

Yup, the link does work :)

I'll update the doco once I get a bit of time to clean up things and publish 0.4.

If you see any other issues, especially running on Windows, don't hesitate to let me know

And thank you again for reaching out. It's been invaluable 👏

[KirstieJane]

Thank you! I love this tool.

I hacked something together just in case anyone wanted to do the following. If it's useful please feel free to use it/share etc (maybe it should be on the js-hatrack repo page?). And if I'm doing something bad then please also tell me to cease and desist!

How to save a static version of the js-hatrack page

• Problem: At the moment you can only see the contributors for a github repo via https://labhr.github.io/js-hatrack/ if you're logged into GitHub (because the information is pulled in real time to create the webpage and you need to be verified by GitHub to be allowed to send enough requests to compile the information). I'd like to host a page on my website that means _anyone_ can see who has contributed without requiring the buy in of creating a GitHub account.
• Solution: A project member logs in with GitHub and create the lovely looking page via https://labhr.github.io/js-hatrack/ then saves a non-dynamic copy using the Scrapbook Firefox add on.

Instructions

• Install the Scrapbook Firefox add on
• Create the Lets Build a Hat Rack contributers page for your project:
  • Go to https://labhr.github.io/js-hatrack/
  • Login with GitHub
  • Enter the repository name
  • Click go!
• Save the page to your local machine using Scrapbook (click alt to see the Firefox browser menu). * Copy this folder (which is helpfully named with the date and time that you downloaded it) to your website's folder.

And you're done! 🎉 ✨

Here's an example: http://kirstiejane.github.io/STEMMRoleModels/octohatrack_output/Scrapbook_20160317092940/index.html

Thank you to this answer on StackExchange for providing this hack solution!

[glasnt]

I've added this as a PR to hatrack, thank you so much! 🎉

[KirstieJane]

Fantastic. And thank you for the awesome tool!