w3c / scribejs

Converter of RRSAgent IRC logs into minutes in markdown
https://w3c.github.io/scribejs/BrowserView/
Other
11 stars 14 forks source link

GitHub Pages Hosting of new BrowserView #64

Closed BigBlueHat closed 5 years ago

BigBlueHat commented 5 years ago

The BrowserView directory has a staticly hostable UX for building minutes output from IRC logs, but we can't host out of that directory via GitHub Pages. Consequently, we have three options:

  1. we can move the UX to the root folder (on master)
  2. a dedicated BrowserView contents only branch (which is a pain to maintain)
  3. or rename BrowserView to docs--which we can configure to host out of

My preference would be option 3, as its the simplest to setup.

@iherman let me know your thoughts, and I can send an appropriate PR, and then you can click the things in Settings. 😄

Cheers! 🎩

iherman commented 5 years ago

@BigBlueHat I do not understand. https://w3c.github.io/scribejs/BrowserView/ simply works, because I had set the repository accordingly:

untitled

Ie, I do not understand what is the problem...

BigBlueHat commented 5 years ago

Yeah. I guess I was thinking https://w3c.github.io/scribejs/ was nicer. 😄

I can just add a big "Demo" button or something to the readme hosted at https://w3c.github.io/scribejs/ and that would do the trick.

Also, could you set https://w3c.github.io/scribejs/ or https://w3c.github.io/scribejs/BrowserView/ as the "homepage" for this repo?

iherman commented 5 years ago

Yeah. I guess I was thinking https://w3c.github.io/scribejs/ was nicer.

I am not sure. scribejs as a command line tool is richer than what the web interface provides. For example, it is not possible to automatically upload from the web view to a github repository, although the command line tool does it. Also, the scribejs tool currently checks the nickname file against a JSON schema, but this is not done (yet?) in the web page. Giving the browser view as the home page gives a wrong impression.

Having a more prominent note on the page about the existence of the browser view is a good idea, though.

BigBlueHat commented 5 years ago

Cool. Then if you link to https://w3c.github.io/scribejs/ folks will get the README in HTML, and then I'll add a more prominent demo link to the README, and we'll be all set. 😃

Great list of things to add to the BrowserView too, btw! Issues forthcoming. 😉

BigBlueHat commented 5 years ago

So. Action here would be to set https://w3c.github.io/scribejs/ as the homepage on this repo.

BigBlueHat commented 5 years ago

Added a link to the readme in 82a2f8b12273e01204482565a792bdb9282af67d, so closing as fixed. 😃