Disclaimer texts on generated pages

kvz · kvz · commit 9fbfb59f17ee · 2013-09-17T14:36:14.000+02:00
diff --git a/_octopress/Rakefile b/_octopress/Rakefile
@@ -15,16 +15,16 @@ deploy_branch  = "gh-pages"
 
 ## -- Misc Configs -- ##
 
-public_dir      = "public/phpjs"    # compiled site directory
-source_dir      = "source"    # source file directory
-blog_index_dir  = 'source'    # directory for your blog's index page (if you put your index in source/blog/index.html, set this to 'source/blog')
-deploy_dir      = "_deploy"   # deploy directory (for Github pages deployment)
-stash_dir       = "_stash"    # directory to stash posts for speedy generation
-posts_dir       = "_posts"    # directory for blog files
-themes_dir      = ".themes"   # directory for blog files
-new_post_ext    = "markdown"  # default new post file extension when using the new_post task
-new_page_ext    = "markdown"  # default new page file extension when using the new_page task
-server_port     = "4000"      # port for preview server eg. localhost:4000
+public_dir     = "public/phpjs"    # compiled site directory
+source_dir     = "source"    # source file directory
+blog_index_dir = 'source'    # directory for your blog's index page (if you put your index in source/blog/index.html, set this to 'source/blog')
+deploy_dir     = "_deploy"   # deploy directory (for Github pages deployment)
+stash_dir      = "_stash"    # directory to stash posts for speedy generation
+posts_dir      = "_posts"    # directory for blog files
+themes_dir     = ".themes"   # directory for blog files
+new_post_ext   = "markdown"  # default new post file extension when using the new_post task
+new_page_ext   = "markdown"  # default new page file extension when using the new_page task
+server_port    = "4000"      # port for preview server eg. localhost:4000
 
 
 desc "Build jekyll source by php.js source"
@@ -63,6 +63,10 @@ task :build do
   page_fncs.puts "- /packages"
   page_fncs.puts "---"
   page_fncs.puts "<!-- Generated by Rakefile:build -->"
+  page_fncs.puts "If you are missing functions, there is a chance you may find them in our [experimental](https://github.com/kvz/phpjs/tree/master/experimental) "
+  page_fncs.puts "and [workbench](https://github.com/kvz/phpjs/tree/master/workbench) folders. Warning: we keep "
+  page_fncs.puts "these functions there for a reason.  "
+
 
   Dir.chdir("../functions")
   Dir.glob("*/").each { |dir|
@@ -154,8 +158,17 @@ task :build do
       page_fnc.puts "#{contents}"
       page_fnc.puts "{% endcodeblock %}"
       page_fnc.puts ""
-      page_fnc.puts " - [view on github](https://github.com/kvz/phpjs/blob/master/functions/#{category}/#{function}.js)"
-      page_fnc.puts " - [edit on github](https://github.com/kvz/phpjs/edit/master/functions/#{category}/#{function}.js)"
+      page_fnc.puts " - [Raw function on GitHub](https://github.com/kvz/phpjs/blob/master/functions/#{category}/#{function}.js)"
+      page_fnc.puts ""
+      page_fnc.puts "Please note that php.js uses JavaScript objects as substitutes for PHP arrays, they are "
+      page_fnc.puts "the closest match to this hashtable-like data structure. "
+      page_fnc.puts ""
+      page_fnc.puts "Please also note that php.js offers community built functions and goes by the "
+      page_fnc.puts "[McDonald’s Theory](https://medium.com/what-i-learned-building/9216e1c9da7d). We'll put online "
+      page_fnc.puts "functions that are far from perfect, in the hopes to spark better contributions. "
+      page_fnc.puts "Do you have one? Then please just: "
+      page_fnc.puts ""
+      page_fnc.puts " - [Edit on GitHub](https://github.com/kvz/phpjs/edit/master/functions/#{category}/#{function}.js)"
       page_fnc.puts ""
 
       ['1', '2', '3'].each do |i|
