From 3ecf1ff9365f0857b45d8095a6d2e956bba6250e Mon Sep 17 00:00:00 2001 From: Marcin Kulik Date: Mon, 14 Oct 2013 16:16:28 +0200 Subject: [PATCH] Put installation instructions on a separate docs page --- app/views/docs/_docs_topics.html.slim | 3 ++- ...ord.html.slim => gettingstarted.html.slim} | 16 +++----------- app/views/docs/installation.html.slim | 22 +++++++++++++++++++ app/views/layouts/_navigation.html.slim | 2 +- config/routes.rb | 2 +- 5 files changed, 29 insertions(+), 16 deletions(-) rename app/views/docs/{record.html.slim => gettingstarted.html.slim} (72%) create mode 100644 app/views/docs/installation.html.slim diff --git a/app/views/docs/_docs_topics.html.slim b/app/views/docs/_docs_topics.html.slim index e6e411e..a4df1cd 100644 --- a/app/views/docs/_docs_topics.html.slim +++ b/app/views/docs/_docs_topics.html.slim @@ -2,7 +2,8 @@ h1 Docs ul.delimited li = link_to_category 'About', docs_path(:about), :about - li = link_to_category 'Getting started', docs_path(:record), :record + li = link_to_category 'Getting started', docs_path(:gettingstarted), :gettingstarted + li = link_to_category 'Installation', docs_path(:installation), :installation li = link_to_category 'Recorder options', docs_path(:options), :options li = link_to_category 'Embedding', docs_path(:embedding), :embedding li = link_to_category 'FAQ', docs_path(:faq), :faq diff --git a/app/views/docs/record.html.slim b/app/views/docs/gettingstarted.html.slim similarity index 72% rename from app/views/docs/record.html.slim rename to app/views/docs/gettingstarted.html.slim index f27bed3..e594397 100644 --- a/app/views/docs/record.html.slim +++ b/app/views/docs/gettingstarted.html.slim @@ -2,7 +2,7 @@ markdown: # Getting started - ## 1. Install recorder + ## 1. Install the recorder The latest __stable version__ of asciinema can always be installed or updated to via [pip](http://www.pip-installer.org/en/latest/index.html) (prefered) or @@ -10,18 +10,8 @@ markdown: sudo pip install --upgrade asciinema - Alternatively: - - sudo easy_install asciinema - - Or, you can install the __development version__ directly from GitHub: - - sudo pip install --upgrade https://github.com/sickill/asciinema/tarball/master - - Arch Linux users can install the - [AUR](https://aur.archlinux.org/packages/asciinema/) package: - - yaourt -S asciinema + See [installation docs](#{docs_path(:installation)}) for all installation + methods. ## 2. Record diff --git a/app/views/docs/installation.html.slim b/app/views/docs/installation.html.slim new file mode 100644 index 0000000..257726b --- /dev/null +++ b/app/views/docs/installation.html.slim @@ -0,0 +1,22 @@ +markdown: + + # Installation + + The latest __stable version__ of asciinema can always be installed or updated + to via [pip](http://www.pip-installer.org/en/latest/index.html) (prefered) or + easy\_install: + + sudo pip install --upgrade asciinema + + Alternatively: + + sudo easy_install asciinema + + Or, you can install the __development version__ directly from GitHub: + + sudo pip install --upgrade https://github.com/sickill/asciinema/tarball/master + + Arch Linux users can install the + [AUR](https://aur.archlinux.org/packages/asciinema/) package: + + yaourt -S asciinema diff --git a/app/views/layouts/_navigation.html.slim b/app/views/layouts/_navigation.html.slim index 6a933b7..8eb1b8a 100644 --- a/app/views/layouts/_navigation.html.slim +++ b/app/views/layouts/_navigation.html.slim @@ -1,3 +1,3 @@ ul li = link_to "Browse", browse_path - li = link_to "Docs", docs_path(:record) + li = link_to "Docs", docs_index_path diff --git a/config/routes.rb b/config/routes.rb index 4c96941..27436c8 100644 --- a/config/routes.rb +++ b/config/routes.rb @@ -11,7 +11,7 @@ Asciinema::Application.routes.draw do get "/~:nickname" => "users#show", :as => :profile - get "/docs" => "docs#show", :page => 'record', :as => :docs_index + get "/docs" => "docs#show", :page => 'gettingstarted', :as => :docs_index get "/docs/:page" => "docs#show", :as => :docs get "/auth/:provider/callback" => "sessions#create"