documentator 0.0.3 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9b963ef4ea1b4cde6792411d46cba1b3bc967f75
-  data.tar.gz: 7df81ea85e431d434ba3eb5c176bd8c6128e9579
+  metadata.gz: 7e09f4c8c041881638c3bbd0d7076d2689863854
+  data.tar.gz: 1a34de1fc0c0a419d7b6b7666255f30a1a159220
 SHA512:
-  metadata.gz: f00c4c845426e9ac25f8dc694074bcd30e3b06c6fae96a245dd5e9808c9117ad16b1bb33095997657dbc2b61c99559087ff8c9c830ee5aa01a5cee23d232e74f
-  data.tar.gz: a0be1033c8d0f97d1aac90cb3c71c011e5f7bb156d16ca000d10792083e0b694706f97c0749a5ceabce7a820c6df127e6a6b7f0e0e4cdda8a6d13b69e3454886
+  metadata.gz: ce479d595b8cf88a6d43103ae13cf2dee8603e9ca3147f8aa4ddd52fea7fc5e32f430c2f1f6b9f250f8f77bd6870cbe0565761302f5e0a2abedf2bdf56af938e
+  data.tar.gz: 5f3a96bf4de980b6dee781c6524a1480d817c98082f295f85bf7842f8fac2497f6219c3cc044087aaf502448412e1a653f267960ef901e4183958996ec3753c8

data/README.md

@@ -1,32 +1,10 @@
 # documentator
 
-documentator has one primary goal: having better docs on our projects.
+`documentator` has one primary goal: having better docs on our projects.
 
 documentator provides two main features to achieve that goal:
 
 
-### Bootstrap
-
-`bootstrap` provides a minimal set of documentation's file.
-Those are empty, and they *must* be written for each project. This is specific
-to each project:
-
-  * What's the architecture (providing a [ditaa](http://ditaa.sourceforge.net/)
-  schema will make you earns some karma points)?
-  * Dependencies?
-  * Environnements?
-
-
-As a treat, `bootstrap` generates a Gemfile in `project/doc` which include
-[Guide'em up](https://github.com/nono/guide-em-up). Guide'em up can be used to
-preview markdown file in a browser.
-
-### Import
-
-`import` provides some templates of common documentation that should be the same
-from one project to another. And yet, we write them on each project. I mean,
-installing ElasticSearch is always the same.
-
 ## Installation
 
 With bundler, add it to your `Gemfile`:
@@ -43,18 +21,45 @@ Commands should be used from the root directory of the current project.
 
 ### Bootstrap
 
+`bootstrap` provides a minimal set of documentation files.
+Those are empty, and they *must* be written for each project. The content is
+specific to each project:
+
+  * What's the architecture? (providing a [ditaa](http://ditaa.sourceforge.net/)
+schema will  earn you some extra karma points)
+  * Dependencies?
+  * Environnements?
+
+As a treat, `bootstrap` generates a Gemfile in `project/doc` which includes
+[Guide'em up](https://github.com/nono/guide-em-up). Guide'em up can be used to
+preview markdown file in a browser.
+
+
 ``` bash
 bundle exec documentator bootstrap
 ```
 
 ### Importing templates
 
+`import` provides templates for common documentation that should be the same
+from one project to another. Installing ElasticSearch is basically always the
+same. If there are projet specific particularities, you can always add them
+here.
+
 ``` bash
 bundle exec documentator list
 ```
 
+A language can be specified to the `list` command.
+
+``` bash
+bundle exec documentator list fr
+```
+
+A language must be specified to the `import` command.
+
 ``` bash
-bundle exec documentator import nginx ruby
+bundle exec documentator import fr beasntalkd mongodb
 ```
 
 ## Contribution

data/lib/documentator.rb

@@ -16,14 +16,14 @@ module Documentator
     end
 
     desc "import a template to doc directory"
-    def import(*templates)
+    def import(locale, *templates)
       templates.each do |template|
         begin
           unless File.exists?(doc_path)
             puts "You should run `bootstrap` before trying to import documentation"
             exit 1
           end
-          cp(templates_path.join("#{template}.md"), doc_path)
+          cp(templates_path.join(locale, "#{template}.md"), doc_path)
           puts "✓ File #{template} copied."
         rescue Errno::ENOENT
           puts "x File #{template} not found."
@@ -32,9 +32,12 @@ module Documentator
     end
 
     desc "List all templates"
-    def list
-      Dir[templates_path.join("*")].each do |file|
-        puts "* #{File.basename(file, File.extname(file))}"
+    def list(locale = nil)
+      Dir[templates_path.join(locale || "*")].each do |locale|
+        puts "* #{File.basename(locale)}"
+        Dir[templates_path.join(locale, "*")].each do |file|
+          puts "  * #{File.basename(file, File.extname(file))}"
+        end
       end
     end
 

data/lib/documentator/templates/fr/zeromq.md

@@ -0,0 +1,22 @@
+# ZeroMQ / ØMQ
+
+ØMQ est une librairie de manipulation de socket. Il ne s'agit pas d'un serveur,
+il n'y a donc aucun processus ØMQ à lancer. ØMQ s'approche plus d'un langage.
+
+## Installation
+
+### Debian
+
+En tant que root:
+
+``` bash
+aptitude install libzmq-dev
+```
+
+Ou pour la branche 3.2:
+
+``` bash
+aptitude install libzmq-dev
+```
+
+Et, c'est tout.

data/lib/documentator/version.rb

@@ -1,4 +1,4 @@
 # encoding: utf-8
 module Documentator
-  VERSION = "0.0.3"
+  VERSION = "0.1.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: documentator
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.1.0
 platform: ruby
 authors:
 - chatgris
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-04-02 00:00:00.000000000 Z
+date: 2013-04-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: boson
@@ -44,14 +44,15 @@ files:
 - lib/documentator/bootstrap/Deploy.md
 - lib/documentator/bootstrap/Environments.md
 - lib/documentator/bootstrap/Gemfile
-- lib/documentator/templates/beanstalkd.md
-- lib/documentator/templates/capistrano.md
-- lib/documentator/templates/elasticsearch.md
-- lib/documentator/templates/grunt.md
-- lib/documentator/templates/mongodb.md
-- lib/documentator/templates/neo4j.md
-- lib/documentator/templates/postgresql.md
-- lib/documentator/templates/ruby.md
+- lib/documentator/templates/en/ruby.md
+- lib/documentator/templates/fr/beanstalkd.md
+- lib/documentator/templates/fr/capistrano.md
+- lib/documentator/templates/fr/elasticsearch.md
+- lib/documentator/templates/fr/grunt.md
+- lib/documentator/templates/fr/mongodb.md
+- lib/documentator/templates/fr/neo4j.md
+- lib/documentator/templates/fr/postgresql.md
+- lib/documentator/templates/fr/zeromq.md
 - lib/documentator/version.rb
 homepage: https://github.com/AF83/documentator
 licenses: []
@@ -77,3 +78,4 @@ signing_key:
 specification_version: 4
 summary: Documents all the things
 test_files: []
+has_rdoc: