Add basic getting started guide for Hanami and placeholders for other frameworks

beauby · beauby · commit 591cfe5d5109 · 2017-03-28T02:43:04.000+02:00
diff --git a/source/guides/getting_started/hanami.html.erb.md b/source/guides/getting_started/hanami.html.erb.md
@@ -0,0 +1,69 @@
+---
+layout: guides
+---
+# Getting started - Hanami
+
+In order to get a Hanami app rolling with jsonapi-rb, you will usually want to follow those 3 steps:
+
+1. Add `jsonapi-hanami` to your `Gemfile`:
+
+```ruby
+# Gemfile
+
+gem 'jsonapi-hanami'
+```
+
+2. Declare the `:jsonapi` MIME type (for serialization):
+
+```ruby
+# apps/foo/application.rb
+
+module Foo
+  class Application < Hanami::Application
+    configure do
+      # ...
+      controller.format jsonapi: 'application/vnd.api+json'
+      # ...
+    end
+  end
+end
+```
+
+3. Enable the JSON body parser (for deserialization):
+
+```ruby
+# apps/foo/application.rb
+
+module Foo
+  class Application < Hanami::Application
+    configure do
+      # ...
+      body_parsers :json
+      # ...
+    end
+  end
+end
+```
+
+4. Optional: Add `apps/foo/resources/` to the `load_path`:
+
+```ruby
+# apps/foo/application.rb
+
+module Foo
+  class Application < Hanami::Application
+    configure do
+      # ...
+      load_paths << [
+        # ...
+        'resources'
+      ]
+      # ...
+    end
+  end
+end
+```
+
+## Examples
+
+<%= partial 'peeks/hanami' %>
diff --git a/source/guides/getting_started/plain_ruby.html.erb.md b/source/guides/getting_started/plain_ruby.html.erb.md
@@ -0,0 +1,10 @@
+---
+layout: guides
+---
+# Getting started - Plain ruby
+
+Soon
+
+## Examples
+
+<%= partial 'peeks/plain' %>
diff --git a/source/guides/getting_started/rails.html.erb.md b/source/guides/getting_started/rails.html.erb.md
@@ -0,0 +1,10 @@
+---
+layout: guides
+---
+# Getting started - Ruby on Rails
+
+Soon
+
+## Examples
+
+<%= partial 'peeks/rails' %>
diff --git a/source/guides/getting_started/sinatra.html.erb.md b/source/guides/getting_started/sinatra.html.erb.md
@@ -0,0 +1,6 @@
+---
+layout: guides
+---
+# Getting started - Sinatra
+
+Soon
diff --git a/source/layouts/guides.erb b/source/layouts/guides.erb
@@ -13,6 +13,15 @@
         <li class="toc-group">
           <a href="/guides">Introduction</a>
         </li>
+        <li class="toc-group">
+          Getting started
+          <ul>
+            <li><a href="/guides/getting_started/plain_ruby.html">Plain ruby</a></li>
+            <li><a href="/guides/getting_started/sinatra.html">Sinatra</a></li>
+            <li><a href="/guides/getting_started/hanami.html">Hanami</a></li>
+            <li><a href="/guides/getting_started/rails.html">Ruby on Rails</a></li>
+          </ul>
+        </li>
         <li class="toc-group">
           <a href="/guides/serialization">Serialization</a>
           <ul>

-Original file line number
+Diff line change
@@ @@ -0,0 +1,6 @@ @@
 +---
 +layout: guides
 +---
 +# Getting started - Sinatra
++
 +Soon