search

baconjs / bacon.js

Functional reactive programming library for TypeScript and JavaScript
https://baconjs.github.io
MIT License
6.47k stars 331 forks source link

Website (and logo) #58

Closed raimohanska closed 11 years ago

raimohanska commented 11 years ago

I'm planning on setting up a website for bacon.js. So far, I've got some ideas.

This is something I'll need help with. I ain't got mad skillzz with Photoshop, for instance.

I'm thinking something more in the spirit of

francis

than

mrbacon

raimohanska commented 11 years ago

Not sure yet if github pages would do for hosting. I want interactive ajax examples! The ajax part might be mockjaxed though.

eskimoblood commented 11 years ago

We could fake it with sinonjs: http://emdin.info/r/sinon-talk/#8

RoboTeddy commented 11 years ago

Also, some public endpoints support cross-domain ajax via CORS (for modern browsers at least)

mileskin commented 11 years ago

The easiest way to fake ajax responses is probably with mockjax

$.mockjax({url: /\/api\/foo/, dataType: 'json', responseText: {foo: 1}})
mileskin commented 11 years ago

I would be very happy if bacon had a responsive site that would nicely adapt to different screen sizes, like these:

Would be nice to read the api/examples also with cell phone / tablet.

mileskin commented 11 years ago

[RE: responsive site] Also http://lodash.com/docs

irskep commented 11 years ago

Is anyone working on this? I've set up gh-pages with simple docs for a few projects. IMO Bacon.js is most in need of an easily navigable reference page. Given that I look at the Readme about every other day it's been bugging me. Would you be interested in a simple interim site that just puts the existing Readme.md in a backbonejs.org/underscorejs.org style page with a sidebar TOC/reference?

Other docs I've written:

I'd be fine learning nanoc. It looks like Jekyll and I've used that.

(Basic responsive layout is pretty simple.)

raimohanska commented 11 years ago

Wow! Agreed totally, and interested too! No-one is working on it right now, so go for it!

I'd be very happy to delegate the website stuff to others while concentrating on the actual Bacon :) Unfortunately I have very little time to put into my open-source work, so all help is appreciated. And dude, I've already got tons of help from the community with all kinds of wonderful stuff I would have never even thought of myself.

irskep commented 11 years ago

Do you want me to clone baconjs-website or should I work in the gh-pages branch? If you want bacon.github.com or something, you'll need to make a Github Org for that with a special repo. (I do recommend doing that; it makes the canonical repository easier to find and have a separate repo for the web site.)

Also, I don't know the first thing about auto-generated docs from Coffescript (other than docco, which doesn't see appropriate here), so it's all going to be by hand.

Going with a blank gh-pages branch for now, but it'll be simple to transplant if you'd prefer something else.

irskep commented 11 years ago

Second question: how much do you want to use nanoc over jekyll? I couldn't make nanoc generate a table of contents, whereas I can with jekyll.

raimohanska commented 11 years ago

The org thing sounds fine, I'll look into that. We can, at least, start with Jekyll to get some stuff done.

irskep commented 11 years ago

Yep, it's all Markdown anyway. I don't plan to use many (any) generator-specific features.

stephenjudkins commented 11 years ago

Emphasizing Francis over pork belly would, IMO, be a good idea. I have both vegetarian and Muslim coworkers to whom the reference to the meat wouldn't go over as well as it would for me.

ProLoser commented 11 years ago

In the mean time, while you guys are fiddling around: http://www.cheatography.com/proloser/cheat-sheets/bacon-js/

I recommend also making the docs Dash-App compatible

raimohanska commented 11 years ago

Oh, that looks nice! You're very welcome to contribute to Bacon.js development. Please do PR :)

irskep commented 11 years ago

On my end, I looked for a good JS documentation tool and/or static site generator and hated them all, so my efforts petered out. Can't we just have Sphinx for Coffescript? :-(

raimohanska commented 11 years ago

Document generation from the actual source code might be nice, but I don't see that as a must. I might try nanoc and use its metadata capabilities for structured data like API docs. But then again, the stage is definitely open for anyone who wants to step up, using any tools necessary :)

ProLoser commented 11 years ago

I just added the Observable Interface section to the cheat sheet (I can't believe I forgot it).

irskep commented 11 years ago

This might be an easy way to get started with a gh-pages site. http://documentup.com/

antris commented 11 years ago

This issue seems to be hanging. How about we make just some website, and then split the rest of the stuff into separate issues?

raimohanska commented 11 years ago

Why not. It must not, however, mean duplication of the content in README. Either

a) the site is to be (partly) generated from readme or b) both are to be generated from the same source or c) the API documentation could be removed from README, to be included exclusively on the site.

@antris plsmkithpn!

antris commented 11 years ago

Or maybe d) no documentation on the site at all, just a link to README on GitHub?

We can have just the site up, and then later on add docs etc. when someone has the time to do the generated docs. (This would be a separate issue)

raimohanska commented 11 years ago

What's the point of the site in case d? Ive been thinking about a useful information site...

-juha-

On 29.9.2013, at 12.39, Anton Rissanen notifications@github.com wrote:

Or maybe d) no documentation on the site at all, just a link to README on GitHub?

— Reply to this email directly or view it on GitHub.

antris commented 11 years ago

It would be just a simple home page that focuses on communicating clearly what Bacon.js is rather than being the reference documentation. Also, branding it as a serious library (not just a "random project" on GitHub).

It would also be an useful step as a spike, so we could get the domain, hosting and CI/build system sorted out for the website.

This issue seems to be stalling, because we are looking for the "Final Solution" and attaching many different needs into one issue. It would be a whole lot of work before we would get anything into production if we are waiting for all of these needs to be solved at the same time.

After we have just some website, it's easier to split the issue.

philipnilsson commented 11 years ago

Agree with @antris. User story #1: There is a website. It has the word Bacon on it.

I suggest creating a new Bacon-website repo in this organization, and create gh-pages. Then write down a list of issues of things we'd like to do, while closing this issue. We maintain the README as is, at least for now.

Also, I really like the idea of a "Cooking with Bacon" set of examples/patterns.

raimohanska commented 11 years ago

All rite! Let's do this then. 1) make new repo 2) draft the initial contents if the page 3) get a cool layoit from one of our ADs 4) make it happen 5) ??? 6) profit ?

-juha-

On 29.9.2013, at 13.45, Anton Rissanen notifications@github.com wrote:

It would be just a simple home page that focuses on communicating clearly what Bacon.js is rather than being the reference documentation. Also, branding it as a serious library (not just a "random project" on GitHub).

It would also be an useful step as a spike, so we could get the domain, hosting and CI/build system sorted out for the website.

— Reply to this email directly or view it on GitHub.

philipnilsson commented 11 years ago

I don't think I have rights to create a new repository. Can you make that happen, or create the repo yourself @raimohanska ?

raimohanska commented 11 years ago

https://github.com/baconjs/bacon-website

philipnilsson commented 11 years ago

Ok got this started. Also don't have permissions to set up gh-pages, so once that's done we can close this and open up bugs in bacon-website.

raimohanska commented 11 years ago

Hmm.. setup gh pages... I already added the bacon.js team as collaborator for bacon-webshite. What's to be done?

I mean, what's the problem and how can I help?

philipnilsson commented 11 years ago

Its somewhere on the settings page of the repo, which I don't have access to. On Oct 1, 2013 7:21 PM, "Juha Paananen" notifications@github.com wrote:

Hmm.. setup gh pages... I already added the bacon.js team as collaborator for bacon-webshite. What's to be done?

— Reply to this email directly or view it on GitHubhttps://github.com/baconjs/bacon.js/issues/58#issuecomment-25470390 .

ProLoser commented 11 years ago

Why aren't you guys just doing baconjs.github.io like everyone else on Github does? On Oct 1, 2013 12:30 PM, "philipnilsson" notifications@github.com wrote:

Its somewhere on the settings page of the repo, which I don't have access to. On Oct 1, 2013 7:21 PM, "Juha Paananen" notifications@github.com wrote:

Hmm.. setup gh pages... I already added the bacon.js team as collaborator for bacon-webshite. What's to be done?

— Reply to this email directly or view it on GitHub< https://github.com/baconjs/bacon.js/issues/58#issuecomment-25470390> .

— Reply to this email directly or view it on GitHubhttps://github.com/baconjs/bacon.js/issues/58#issuecomment-25480237 .

philipnilsson commented 11 years ago

@ProLoser Didn't know you could do that, but would be good. Still would like to have an issue tracker etc if possible.

ProLoser commented 11 years ago

For the website? Why not use github issues... ?

If it's not powerful enough you could help us out as I'm working on another project where you can add metadata to github issues.

On Tue, Oct 1, 2013 at 4:57 PM, philipnilsson notifications@github.comwrote:

@ProLoser https://github.com/ProLoser Didn't know you could do that, but would be good. Still would like to have an issue tracker etc if possible.

— Reply to this email directly or view it on GitHubhttps://github.com/baconjs/bacon.js/issues/58#issuecomment-25502738 .

Dean J Sofer DeanSofer@gmail.com

BS Computer Information Systems California State Polytechnic University, Pomona Telephone: 714-900-2254 Website: www.DeanSofer.com Github: github.com/ProLoser

philipnilsson commented 11 years ago

@ProLoser Am I right to say that in order to get an organization website you have to name the repository after the organization? Which we are already doing with this repo? That would mean we wouldn't have a separate issue tracker for the website. Can we work around that, or am I just getting it wrong?

ProLoser commented 11 years ago

You are wrong. I'm surprised you guys don't know gh-pages that well. The repo must be named exactly the way I typed it earlier. That repo would be separate from the bacon code base and therefore will have its own issue tracker. Once the repo is created and contains at least an index.html you will be able to visit the url of the same name.

[organization].github.io

So: baconjs.github.io On Oct 2, 2013 3:03 AM, "philipnilsson" notifications@github.com wrote:

@ProLoser https://github.com/ProLoser Am I right to say that in order to get an organization website you have to name the repository after the organization? Which we are already doing with this repo? That would mean we wouldn't have a separate issue tracker for the website. Can we work around that, or am I just getting it wrong?

— Reply to this email directly or view it on GitHubhttps://github.com/baconjs/bacon.js/issues/58#issuecomment-25527189 .

philipnilsson commented 11 years ago

It's running, so we should close this. Thanks @ProLoser !