Giters

philschatz / gh-board

:octocat: "Serverless" Kanban for GitHub Issues using gh-pages

Home Page:http://philschatz.github.io/gh-board/

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

should have a better homepage

philschatz opened this issue · comments

commented

Since most users seem to fork this repo and then host it on github.io using gh-pages this code should be smart enough to show a listing of repositories using the subdomain in the ${NAME}.github.io URL. This would allow people to have a useful "Homepage" listing all the repositories to choose from rather than a generic "Demo" page.

commented

I think the easiest way to do it would be to use the repository field of the package.json. This would also be useful for new-version-checker.js (telling me to reload because there is a new version on philschatz/gh-board doesn't help for forks)

commented

Oh, http://philschatz.com/gh-board/package.json does load!

What if we used Jekyll to generate a JSON file containing the latest sha and just polled that file, instead of using package.json (and making sure the deploy script updates the repository field).

I have seen the sha before on Jekyll-generated pages so it should just be a little file that would need to be added.

Also, thanks for all the Pull Requests and Issue comments; want to help maintain this repository?

commented

I'm not sure I understand the sha thing. What I meant was to import {repository} from '../package.json' in the new-version-checker.js so that the repo is known at build time. (And then add an instruction to change the package.json when forking the repo)

want to help maintain this repository?

Sure! I have a developer friend (@charlottebretonsch) interested in helping on the design side as well

commented

I was thinking that Jekyll could generate a metadata.json file that contains the sha that is deployed (using https://github.com/jekyll/github-metadata#overrides ). Then, gh-board could just poll that file (instead of philschatz/gh-board#gh-pages) to see when it changes and know that the user should refresh their page. That way:

  • Jekyll does the the work to make sure it is updated properly
  • forks would get notified when the fork is updated, not when the main repo is updated
  • forks would use this file to get the GitHub API endpoint and default org repos to list
  • the GET request does not count against GitHub's rate limit
commented

Oh nice, I wasn't aware of that. Looking forward to the PR :)

commented

@coala has sort-of done this at https://github.com/coala/gh-board

We define REPOSITORIES in our Travis CI & Netlify, and also do a lot of pre-fetching so that a user can load all current issues in the repositories even if they havent logged in.

https://coala-gh-board.netlify.com/

Improving the UI to show a set of repositories, even with only GitHub Pages (using Jekyll) sounds like a great addition that we could champion.