Closed solnic closed 10 years ago
so, my idea: use middleman to generate a static html website and put data with library info into some yaml file so that people could submit their libs through PRs on github.
we could add some fancy UI stuff in pure js later on. It would be similar to how microjs.com works.
I was thinking about an index.html (hand crafted), or an index.md plus a makefile to generate the index.html. I'm -1 on yaml, so if we want to have an external declaration we can use ruby directly. I think my preference goes to having a single HTML file, with the list of libraries already there. Agreed on people sending PRs or writing issues. (As a separate topic: we should establish some sort of guide about what kind of libraries or tools we are looking for.)
If the idea of building the final HTML from templates prevails, I'd like to suggest using mote and a makefile.
Some sort of guideline for libraries would be useful but I'd say it should be as vague as possible, after all we still have pull requests to add libraries and we can discuss each as a community on a case-by-case basis, which will no doubt prompt interesting discussion which we will all benefit from.
I'd also include a section at the top with a short manifesto of the values we care for, so as to set the mood for newcomers and explaining our ideas, It should be short and concise like the agile manifesto.
+1 on building an index.html from templates, whenever possible (and practical) we should use ruby libs as long as they are not overkill for our purpose, It's very important that we eat our own dog food as far as implementing things if we want the community to have a solid philosophy. mote + makefile seems like a good idea to me.
Sure, let's use mote but let's keep the list of libs in a separate file. I don't care about the format. I just want it to be separated from the index.html as it'll be easier to maintain it this way.
@pote re guidelines, I think this will sort itself out once we have a bunch of libs already added :)
I added a very simple proof of concept here: https://github.com/soveran/microrb.com/tree/proof_of_concept
@soveran this looks cool. I wonder what we could use for searching. I'm pretty sure there are some nice client-side solutions, right? Anyhow, we could totally start with a simple list along with tags and descriptions. Let command/ctrl+f be our search engine for now :D
@soveran hey I added you to the org, could you push your PoC to the main repo so we could take it from there?
Done!
FYI the website is up and running, it has basic functionality in place but it lacks design so it's plain html with a little bit of js magic.
...hence I'm closing this issue :)
Ideas how to tackle it are most welcome.