Open thbar opened 12 years ago
Another minimalistic example: http://redis.io/download (see below the "set foo bar" and "get foo" )
@Stiivi thanks!
+1
is there chosen a format for the documentation of guides/tutorials?? I am to begin on a new project with aw-etl and activewarehouse(maybe) and it would be great if i could help the project and myself. The success of a open source project really depends on the documentation, especially when it is somewhat complex.
@pgericson I absolutely agree with what you said on documentation.
I will take a stab at a first guides website this week-end.
About the format: I plan to make it work exactly like Vagrant, so this:
https://github.com/mitchellh/vagrant/blob/docs/docs/provisioners/chef_solo.md
translate into this:
http://vagrantup.com/docs/provisioners/chef_solo.html
Do you have suggestions on what those guides should cover?
Can I ping you back once the structure is in place?
Ping away :)
Vagrant looks good.
some kind of flow diagram would speed up the learning process a lot I think
I will be connecting to a lot of API's so maybe I will make a small example of the process of doing that instead of a flat file(even though it is just a job before, but it could show that with a API call it should get some kind of date/user/whatever restriction as to not get everything all the time)
for visualization http://www.omninerd.com/articles/Automating_Data_Visualization_with_Ruby_and_Graphviz could be used... then the visualization code is in the source :)
Hey @pgericson - just to keep you updated a bit:
I don't have much time to finish the docs right now (although I'll get back to this later on), but if you fancy having a look, it's most welcome!
@Stiivi made very good points on the google group: