ofBook direction/roadmap
elburz opened this issue · 7 comments
Is there a direction, road map, or status on current developments on ofBook? Are contributors writing sections they feel like writing or writing about what they are more experienced at? Are we missing anything critical for a new user? I find it hard to get a sense of how to best contribute by just reading through issues and pull requests. Something like a public Trello board could be beneficial to track whos working on what, where we have holes, etc. I've seen a number of new products using this to create public roadmaps that general users who aren't able to contribute to the actual resource can add their input as to which areas are working, which aren't, and what they'd like to see in the future. I'm happy to help contribute to an overall structure to maximize everyone's time when working on this, if it's something that would be beneficial.
there is not alot of active development on the book at the moment -- mostly it's pull requests to fix chapters and some translation efforts. I know @firmread was working on getting corresponding code repo established (not sure where that's at right now) and it will be good to hear from @bakercp about how his students take to the book and what might be missing. I'd personally be interested in adding more case studies and adding new chapters if there are missing pieces. It's a good question to ask for people who are new to the book, "what should we add? what needs love? etc"
Hmm, happy to try and help close some of the open issues and review to see where we might be able to fill some holes. To your point, I think case studies would be great, to provide a design path for new users. If we were going to list/brainstorm those case studies to co-ordinate them, do you have a preferred way to do that?
I'll continue post any holes / omissions I find. And @elburz I agree -- a clearer "roadmap" for the book (and documentation in general) would be great. We made an effort to clarify our documentation contribution channels / priorities at the conference in Denver, but it's not clear if there is a centralized location for that. The most obvious place to me would be to further develop (and potentially itemize) the "contribute" section of the learning page a bit more (http://openframeworks.cc/learning/). I'd also agree that something a bit more dynamic (like Trello) would be better than keeping a list in ofSite. Something that could be embedded would be nice (maybe Trello can do that?).
From a content perspective, are we considering ofBook a tangent piece of the greater documentation or is this a fully standalone piece? For reasons of overlap, matching style, thoroughness, etc.
Re: dynamism. Trello (ironically?) is a good example of using Trello as a roadmap:
https://trello.com/b/nC8QJJoZ/trello-development-roadmap
I think we could expand on that to have stacks for missing sections, sections currently being worked on, sections being edited, etc. Seems like in the simplest implementation, you can put a link to the board in an iframe and it'll display the board and when you click on it you get redirected to the actual Trello app and it opens the details of whatever item you clicked. Check out this implementation:
http://jsfiddle.net/danlec/hmQJP/
There seem to be other implementations on that example, but a number don't seem to work correctly, and in my mind the above example i mentioned (which is near the top) should be more than enough for embedding?
Alternatively, I also just found this, which seems to be an open source Trello-style app that ties directly into your GitHub issues:
https://waffle.io
Seems quite nice, only thing we would lose, functionality-wise, compared to Trello would be that it seems you need to an account to edit, since it ties into your GitHub account I believe:
Link the Waffle IO using their own platform:
https://waffle.io/waffleio/waffle.io
Happy to setup a Trello or Waffle and see how we find it in use, does oF have an organization account it uses for things like this, or should I just make one myself and share it?
Perhaps we could use the new github "Project" feature? https://help.github.com/articles/tracking-the-progress-of-your-work-with-projects/
Oh, that looks great, not sure why that didn't show up in google. Check out this test one I made for our TouchDesigner book. Quite simple in comparison to the issues and pulls we have for this repo, but I added a mix of issues, pulls, and just custom cards for todos that I have to do.
https://github.com/nVoid/Introduction-to-touchdesigner/projects/1
Seems like it might be an easy bet, I can give a shot at trying to organize the issues, pulls, todos, etc into a similar board.
This was just launched <1week ago, so that's probably why you didn't see it. ;-)