Permalink
Browse files

Move the docs to the root directory of the project

1 parent ff38824 commit 31ee296bd96156b0be47489a49521416fc48db69 @JoelMarcey JoelMarcey committed Sep 24, 2016
Showing with 56 additions and 57 deletions.
  1. 0 {docs → }/.gitignore
  2. 0 {docs → }/GemFile
  3. 0 {docs → }/Gemfile.lock
  4. +56 −1 README.md
  5. 0 {docs → }/_config.yml
  6. 0 {docs → }/_config_local_dev.yml
  7. 0 {docs → }/_data/authors.yml
  8. 0 {docs → }/_data/features.yml
  9. 0 {docs → }/_data/nav.yml
  10. 0 {docs → }/_data/nav_docs.yml
  11. 0 {docs → }/_data/powered_by.yml
  12. 0 {docs → }/_data/powered_by_highlight.yml
  13. 0 {docs → }/_data/promo.yml
  14. 0 {docs → }/_docs/hello-world.md
  15. 0 {docs → }/_includes/blog_pagination.html
  16. 0 {docs → }/_includes/content/gridblocks.html
  17. 0 {docs → }/_includes/content/items/gridblock.html
  18. 0 {docs → }/_includes/doc.html
  19. 0 {docs → }/_includes/doc_paging.html
  20. 0 {docs → }/_includes/footer.html
  21. 0 {docs → }/_includes/head.html
  22. 0 {docs → }/_includes/header.html
  23. 0 {docs → }/_includes/hero.html
  24. 0 {docs → }/_includes/home_header.html
  25. 0 {docs → }/_includes/katex_import.html
  26. 0 {docs → }/_includes/katex_render.html
  27. 0 {docs → }/_includes/nav.html
  28. 0 {docs → }/_includes/nav/collection_nav.html
  29. 0 {docs → }/_includes/nav/collection_nav_group.html
  30. 0 {docs → }/_includes/nav/collection_nav_group_item.html
  31. 0 {docs → }/_includes/nav/header_nav.html
  32. 0 {docs → }/_includes/nav_search.html
  33. 0 {docs → }/_includes/plugins/all_share.html
  34. 0 {docs → }/_includes/plugins/ascii_cinema.html
  35. 0 {docs → }/_includes/plugins/button.html
  36. 0 {docs → }/_includes/plugins/github_star.html
  37. 0 {docs → }/_includes/plugins/github_watch.html
  38. 0 {docs → }/_includes/plugins/google_share.html
  39. 0 {docs → }/_includes/plugins/iframe.html
  40. 0 {docs → }/_includes/plugins/like_button.html
  41. 0 {docs → }/_includes/plugins/plugin_row.html
  42. 0 {docs → }/_includes/plugins/post_social_plugins.html
  43. 0 {docs → }/_includes/plugins/slideshow.html
  44. 0 {docs → }/_includes/plugins/twitter_follow.html
  45. 0 {docs → }/_includes/plugins/twitter_share.html
  46. 0 {docs → }/_includes/post.html
  47. 0 {docs → }/_includes/powered_by.html
  48. 0 {docs → }/_includes/social_plugins.html
  49. 0 {docs → }/_includes/tutorial-head.html
  50. 0 {docs → }/_includes/ui/button.html
  51. 0 {docs → }/_layouts/basic.html
  52. 0 {docs → }/_layouts/blog.html
  53. 0 {docs → }/_layouts/blog_default.html
  54. 0 {docs → }/_layouts/default.html
  55. 0 {docs → }/_layouts/doc_default.html
  56. 0 {docs → }/_layouts/doc_page.html
  57. 0 {docs → }/_layouts/docs.html
  58. 0 {docs → }/_layouts/home.html
  59. 0 {docs → }/_layouts/page.html
  60. 0 {docs → }/_layouts/plain.html
  61. 0 {docs → }/_layouts/post.html
  62. 0 {docs → }/_layouts/redirect.html
  63. 0 {docs → }/_layouts/support.html
  64. 0 {docs → }/_layouts/tutorial-default.html
  65. 0 {docs → }/_layouts/tutorial.html
  66. 0 {docs → }/_posts/2016-04-07-blog-post-example.md
  67. 0 {docs → }/_sass/_base.scss
  68. 0 {docs → }/_sass/_blog.scss
  69. 0 {docs → }/_sass/_buttons.scss
  70. 0 {docs → }/_sass/_footer.scss
  71. 0 {docs → }/_sass/_gridBlock.scss
  72. 0 {docs → }/_sass/_header.scss
  73. 0 {docs → }/_sass/_poweredby.scss
  74. 0 {docs → }/_sass/_promo.scss
  75. 0 {docs → }/_sass/_react_docs_nav.scss
  76. 0 {docs → }/_sass/_react_header_nav.scss
  77. 0 {docs → }/_sass/_reset.scss
  78. 0 {docs → }/_sass/_search.scss
  79. 0 {docs → }/_sass/_slideshow.scss
  80. 0 {docs → }/_sass/_syntax-highlighting.scss
  81. 0 {docs → }/_sass/_tables.scss
  82. 0 {docs → }/blog/all.html
  83. 0 {docs → }/blog/index.html
  84. 0 {docs → }/css/hack-tutorial.css
  85. 0 {docs → }/css/main.scss
  86. BIN {docs → }/css/spinner.gif
  87. +0 −56 docs/README.md
  88. 0 docs/{docs → }/index.html
  89. 0 {docs → }/feed.xml
  90. 0 {docs → }/index.md
  91. 0 {docs → }/js/hack_tutorial/codemirror/addon/hint/show-hint.css
  92. 0 {docs → }/js/hack_tutorial/codemirror/addon/hint/show-hint.js
  93. 0 {docs → }/js/hack_tutorial/codemirror/addon/lint/lint.css
  94. 0 {docs → }/js/hack_tutorial/codemirror/addon/lint/lint.js
  95. 0 {docs → }/js/hack_tutorial/codemirror/lib/codemirror.css
  96. 0 {docs → }/js/hack_tutorial/codemirror/lib/codemirror.js
  97. 0 {docs → }/js/hack_tutorial/codemirror/mode/clike/clike.js
  98. 0 {docs → }/js/hack_tutorial/codemirror/mode/php/php.js
  99. 0 {docs → }/js/hack_tutorial/hack_demo.js
  100. 0 {docs → }/js/hack_tutorial/hack_demo_worker.js
  101. 0 {docs → }/js/hack_tutorial/hh_ide.js
  102. 0 {docs → }/js/hack_tutorial/prelude.hhi
  103. 0 {docs → }/js/hack_tutorial/test.html
  104. 0 {docs → }/js/hack_tutorial/tutorial.js
  105. 0 {docs → }/js/hack_tutorial/tutorial_source.js
  106. BIN {docs → }/static/favicon.png
  107. BIN {docs → }/static/fonts/LatoLatin-Black.woff
  108. BIN {docs → }/static/fonts/LatoLatin-Black.woff2
  109. BIN {docs → }/static/fonts/LatoLatin-BlackItalic.woff
  110. BIN {docs → }/static/fonts/LatoLatin-BlackItalic.woff2
  111. BIN {docs → }/static/fonts/LatoLatin-Italic.woff
  112. BIN {docs → }/static/fonts/LatoLatin-Italic.woff2
  113. BIN {docs → }/static/fonts/LatoLatin-Light.woff
  114. BIN {docs → }/static/fonts/LatoLatin-Light.woff2
  115. BIN {docs → }/static/fonts/LatoLatin-Regular.woff
  116. BIN {docs → }/static/fonts/LatoLatin-Regular.woff2
  117. 0 {docs → }/static/logo.svg
  118. BIN {docs → }/static/og_image.png
  119. BIN {docs → }/static/oss_logo.png
  120. 0 {docs → }/tutorial.md
File renamed without changes.
File renamed without changes.
File renamed without changes.
View
@@ -1 +1,56 @@
-The hacklang.org website
+## The hacklang.org landing page content
+
+This directory will contain the landing page and other documentation for hacklang.org. It will contain link to docs.hhvm.com and other relevant places. hacklang.org will be hosted on GitHub pages.
+
+### Run the Site Locally
+
+The requirements for running a GitHub pages site locally is described in [GitHub help](https://help.github.com/articles/setting-up-your-github-pages-site-locally-with-jekyll/#requirements). The steps below summarize these steps.
+
+1. Ensure that you are in the `YOUR-PROJECT/` root directory in your local repo clone (i.e., the same directory where this `README.md` exists). The below RubyGems commands, etc. must be run from there.
+
+2. Make sure you have Ruby and [RubyGems](https://rubygems.org/) installed.
+
+ > Ruby >= 2.2 is required for the gems. On the latest versions of Mac OS X, Ruby 2.0 is the
+ > default. Use `brew install ruby` (or your preferred upgrade mechanism) to install a newer
+ > version of Ruby for your Mac OS X system.
+
+3. Make sure you have [Bundler](http://bundler.io/) installed.
+
+ ```
+ # may require sudo
+ gem install bundler
+ ```
+4. Install the project's dependencies
+
+ ```
+ # run this in the project root directory, where the GemFile is.
+ bundle install
+ ```
+
+ > If you get an error when installing `nokogiri`, you may be running into the problem described
+ > in [this nokogiri issue](https://github.com/sparklemotion/nokogiri/issues/1483). You can
+ > either `brew uninstall xz` (and then `brew install xz` after the bundle is installed) or
+ > `xcode-select --install` (although this may not work if you have already installed command
+ > line tools).
+
+5. Run Jekyll's server.
+
+ ```
+ bundle exec jekyll serve --config=_config.yml,_config_local_dev.yml
+ ```
+
+ > We use `bundle exec` instead of running straight `jekyll` because `bundle exec` will always use the version of Jekyll from our `Gemfile`. Just running `jekyll` will use the system version and may not necessarily be compatible.
+
+6. The site will be served from http://localhost:4000.
+
+### Updating the Bundle
+
+The site depends on Github Pages and the installed bundle is based on the `github-pages` gem.
+Occasionally that gem might get updated with new or changed functionality. If that is the case,
+you can run:
+
+```
+bundle update
+```
+
+to get the latest packages for the installation.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes
View
@@ -1,56 +0,0 @@
-## User Documentation for hacklang.org
-
-This directory will contain the user and feature documentation for hacklang.org. The documentation will be hosted on GitHub pages.
-
-### Run the Site Locally
-
-The requirements for running a GitHub pages site locally is described in [GitHub help](https://help.github.com/articles/setting-up-your-github-pages-site-locally-with-jekyll/#requirements). The steps below summarize these steps.
-
-1. Ensure that you are in the `YOUR-PROJECT/docs` directory in your local repo clone (i.e., the same directory where this `README.md` exists). The below RubyGems commands, etc. must be run from there.
-
-2. Make sure you have Ruby and [RubyGems](https://rubygems.org/) installed.
-
- > Ruby >= 2.2 is required for the gems. On the latest versions of Mac OS X, Ruby 2.0 is the
- > default. Use `brew install ruby` (or your preferred upgrade mechanism) to install a newer
- > version of Ruby for your Mac OS X system.
-
-3. Make sure you have [Bundler](http://bundler.io/) installed.
-
- ```
- # may require sudo
- gem install bundler
- ```
-4. Install the project's dependencies
-
- ```
- # run this in the 'docs' directory
- bundle install
- ```
-
- > If you get an error when installing `nokogiri`, you may be running into the problem described
- > in [this nokogiri issue](https://github.com/sparklemotion/nokogiri/issues/1483). You can
- > either `brew uninstall xz` (and then `brew install xz` after the bundle is installed) or
- > `xcode-select --install` (although this may not work if you have already installed command
- > line tools).
-
-5. Run Jekyll's server.
-
- ```
- bundle exec jekyll serve --config=_config.yml,_config_local_dev.yml
- ```
-
- > We use `bundle exec` instead of running straight `jekyll` because `bundle exec` will always use the version of Jekyll from our `Gemfile`. Just running `jekyll` will use the system version and may not necessarily be compatible.
-
-6. The site will be served from http://localhost:4000.
-
-### Updating the Bundle
-
-The site depends on Github Pages and the installed bundle is based on the `github-pages` gem.
-Occasionally that gem might get updated with new or changed functionality. If that is the case,
-you can run:
-
-```
-bundle update
-```
-
-to get the latest packages for the installation.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes
File renamed without changes.
File renamed without changes
File renamed without changes
File renamed without changes.

0 comments on commit 31ee296

Please sign in to comment.