Added explanatory comments to the config/site.yml file for the blank, bootstrap, and foundation generators.
Jared Lewis
committed Oct 18, 2013
commit 114b7e998221547aa53796b97f5b8dbb83e06c79
Showing 3
changed files with
60 additions
and 18 deletions
generators/blank/config/site.yml.tt
+20
-6
| @@ | @@ -1,19 +1,33 @@ |
| - | # TODO: explain it |
| + | # The name of this site |
| + | # This text displays in the back-office and |
| + | # can be used in templates through the site.name global variable |
| name: <%= config[:name] %> | |
| - | # TODO: explain it |
| + | # The site's subdomain |
| + | # This option is for sites on multi-site engines |
| + | # The value determines where the site can be accessed under the engine's primary domain |
| # subdomain: sample | |
| - | # TODO: explain it |
| + | # An array of domain aliases for the site |
| + | # This option is for sites on multi-site engines |
| # domains: [www.example.com, example.com] | |
| - | # TODO: explain it |
| + | # An array of locales (languages) the site is available in |
| + | # The locale listed first is the site's default locale |
| + | # Locales are specified using ISO language codes |
| + | # Possible locales include: en, de, fr, pl, pt-BR, it, nl, nb, es, ru, et, ja, zh-CN |
| locales: [en] | |
| - | # TODO: explain it |
| + | # The site's timezone |
| + | # This converts the server's time to the site's time zone in templates |
| + | # The TimeZone class from Rail's ActiveSupport is used to interpret the string |
| + | # Sample timezone strings: Tokyo, Beijing, Moscow, Cairo, Paris, Pacific Time (US & Canada) |
| # timezone: Paris | |
| - | # TODO: explain it |
| + | # For SEO purposes, sites may wish to add a relevant string to the <title> tag |
| + | # And include <meta type="keywords"> and <meta type="description"> |
| + | # For this purpose you can set values for these variables here |
| + | # They can be accessed in templates through the site.seo_title, site.meta_keywords, and site.meta_description variables |
| seo_title: <%= @name %> | |
| meta_keywords: "some meta keywords" | |
| meta_description: "some meta description" | |
| \ No newline at end of file | |
generators/bootstrap/config/site.yml.tt
+20
-6
| @@ | @@ -1,19 +1,33 @@ |
| - | # TODO: explain it |
| + | # The name of this site |
| + | # This text displays in the back-office and |
| + | # can be used in templates through the site.name global variable |
| name: <%= config[:name] %> | |
| - | # TODO: explain it |
| + | # The site's subdomain |
| + | # This option is for sites on multi-site engines |
| + | # The value determines where the site can be accessed under the engine's primary domain |
| # subdomain: sample | |
| - | # TODO: explain it |
| + | # An array of domain aliases for the site |
| + | # This option is for sites on multi-site engines |
| # domains: [www.example.com, example.com] | |
| - | # TODO: explain it |
| + | # An array of locales (languages) the site is available in |
| + | # The locale listed first is the site's default locale |
| + | # Locales are specified using ISO language codes |
| + | # Possible locales include: en, de, fr, pl, pt-BR, it, nl, nb, es, ru, et, ja, zh-CN |
| locales: [en] | |
| - | # TODO: explain it |
| + | # The site's timezone |
| + | # This converts the server's time to the site's time zone in templates |
| + | # The TimeZone class from Rail's ActiveSupport is used to interpret the string |
| + | # Sample timezone strings: Tokyo, Beijing, Moscow, Cairo, Paris, Pacific Time (US & Canada) |
| # timezone: Paris | |
| - | # TODO: explain it |
| + | # For SEO purposes, sites may wish to add a relevant string to the <title> tag |
| + | # And include <meta type="keywords"> and <meta type="description"> |
| + | # For this purpose you can set values for these variables here |
| + | # They can be accessed in templates through the site.seo_title, site.meta_keywords, and site.meta_description variables |
| seo_title: <%= @name %> | |
| meta_keywords: "some meta keywords" | |
| meta_description: "some meta description" | |
| \ No newline at end of file | |
generators/foundation/config/site.yml.tt
+20
-6
| @@ | @@ -1,19 +1,33 @@ |
| - | # TODO: explain it |
| + | # The name of this site |
| + | # This text displays in the back-office and |
| + | # can be used in templates through the site.name global variable |
| name: <%= config[:name] %> | |
| - | # TODO: explain it |
| + | # The site's subdomain |
| + | # This option is for sites on multi-site engines |
| + | # The value determines where the site can be accessed under the engine's primary domain |
| # subdomain: sample | |
| - | # TODO: explain it |
| + | # An array of domain aliases for the site |
| + | # This option is for sites on multi-site engines |
| # domains: [www.example.com, example.com] | |
| - | # TODO: explain it |
| + | # An array of locales (languages) the site is available in |
| + | # The locale listed first is the site's default locale |
| + | # Locales are specified using ISO language codes |
| + | # Possible locales include: en, de, fr, pl, pt-BR, it, nl, nb, es, ru, et, ja, zh-CN |
| locales: [en] | |
| - | # TODO: explain it |
| + | # The site's timezone |
| + | # This converts the server's time to the site's time zone in templates |
| + | # The TimeZone class from Rail's ActiveSupport is used to interpret the string |
| + | # Sample timezone strings: Tokyo, Beijing, Moscow, Cairo, Paris, Pacific Time (US & Canada) |
| # timezone: Paris | |
| - | # TODO: explain it |
| + | # For SEO purposes, sites may wish to add a relevant string to the <title> tag |
| + | # And include <meta type="keywords"> and <meta type="description"> |
| + | # For this purpose you can set values for these variables here |
| + | # They can be accessed in templates through the site.seo_title, site.meta_keywords, and site.meta_description variables |
| seo_title: <%= @name %> | |
| meta_keywords: "some meta keywords" | |
| meta_description: "some meta description" | |
| \ No newline at end of file | |