Merge pull request #121 from Tim-Blokdijk/edge

Fixes in documentation

Author: catmando

CONTRIBUTING.md

@@ -1,19 +1,87 @@
-# Contributing to this project
+# Contributing to Hyperstack
 
-We welcome and encourage contribution and would be delighted if you participated in this project.
+We welcome and encourage contribution and would be delighted if you participated in this project.  
+If you're new to Hyperstack but have experience with Ruby (and Rails) and would like to contribute then start with the [ToDo tutorial](https://hyperstack.org/edge/docs/tutorials/todo)
+that way you understand the basic capabilities and lingo of Hyperstack.
 
-## If you think you can improve the docs
+Next would be to start an experimental project that's based on the *edge* Hyperstack codebase.  
+If you just want to build a website with Hyperstack without contributing to Hyperstack itself you're better of sticking to released versions of Hyperstack.
+But presuming you do want to contribute you can change you `Gemfile` in the following way to get your project on *edge*.
 
-Each page on the website has an 'Improve this page' button which will create a PR against the correct file and the correct branch.
+```ruby
+git 'https://github.com/hyperstack-org/hyperstack', branch: 'edge', glob: 'ruby/*/*.gemspec' do
+  gem 'rails-hyperstack'
+  gem 'hyper-component'
+  gem 'hyper-i18n'
+  gem 'hyper-model'
+  gem 'hyper-operation'
+  gem 'hyper-router'
+  gem 'hyper-state'
+  gem 'hyperstack-config'
+  gem 'hyper-trace', group: :development
+end
+
+gem 'foreman', group: :development
+```
+The *edge* branch is the latest work in progress, where specs (automated tests) are passing, for the individual gem.  
+The difference between *edge* and *master*, is that *master* guarantees that all specs across all gems pass, plus *master* is the branch from which new versions are released.  
+
+With this configuration you can track development of Hyperstack itself and discuss changes with the other developers.  
+It's the basic starting point from which you can make different types of contributions listed below under the separate headings.
+
+## If you would like to contribute code to Hyperstack
+
+With the `Gemfile` configuration above you can track Hyperstack development. But you can't contribute code.
+
+For that you need to `git clone https://github.com/hyperstack-org/hyperstack.git`  
+Cd into the directory `cd hyperstack`  
+And change to the *edge* branch: `git checkout edge` (*edge* is the default branch but just to be sure).
+
+Now you're free to fix bugs and create new features.  
+Reconfigure the `Gemfile` of your website project with a [filesystem path](https://bundler.io/gemfile.html) to create a local development environment.  
+```
+TODO: Actually provide an example Gemfile..
+```
+And if your improvements could be interesting to others then push it to Github and create a pull request.
+Then keep reminding the existing developers that you would like your code pulled into the Hyperstack repository.
+When they find the time to look at it and like your code they will kindly ask you to also write some specs before your code is merged. That's a good thing, your code is considered valuable, but does require those tests.
+Please understand that your code can also be rejected because it has security issues, is slow, hard to maintain or buggy (among other things).
+Nobody likes it when this happens, but it can happen. If what you're trying to achieve is making sense then please keep at it.
+If you have wild out of the box ideas that would not match Hyperstack then please use the power to fork away and prove your ideas independently.
+But Hyperstack and Opal are quite happily pushing boundaries, so we might like your crazy ideas.
+
+**Pro tip:** Talk trough your plans for changes before writing a lot of code. Push a few small fixes before starting mayor rewrites.
+
+Hyperstack's [license is MIT](https://github.com/hyperstack-org/hyperstack/blob/edge/LICENSE). All code contributions must be under this license. If code is submitted under a different open source license then this must be explicitly stated. Preferably with an explanation why it can't be MIT.
+
+## If you would like to improve the Hyperstack documentation
+
+Each page on [the website](https://hyperstack.org) has an ***Improve this page*** button which will allow you to edit the underlying markdown file on Github and create a ***pull request***. This is to make it as easy as possible to contribute to the documentation.
+And make small fixes quickly.
+
+If you're planning on making sustained contributions to the documentation we would suggest to do a `git clone https://github.com/hyperstack-org/hyperstack.git` as documented above with code contributions.
+Most documentation is written in .md files under the docs directory and can be edited with dedicated markdown editors or even plain text editors.  
+Push your changes and create a ***pull request*** as if it's a code contribution.
 
 ## If you think you can improve the website
 
-Please create an issue describing your plans and reach out to us in the Gitter chat. Our goal for this site is that it acts as a showcase for all that Hyperstack can do, so your creativity is very welcome.
+The website's code can be found in [this repository](https://github.com/hyperstack-org/website).  
+By running `git clone https://github.com/hyperstack-org/website.git` you can check out your own copy.  
+Please note that this repository does not contain the documentation. The website pulls the most recent markdown files from the *edge* hyperstack repository.
+
+Before you write code to change the website, please create an issue describing your plans and reach out to us in the Gitter chat. Our goal for this site is that it acts as a showcase for all that Hyperstack can do, so your creativity is very welcome.
+
+## If you found a possible bug
 
-## If you find a bug
+You can ask on [gitter chat](https://gitter.im/ruby-hyperloop/chat) if you're making a mistake or actually found a bug.  
+Also check the GitHub issue list and if you don't find it mentioned there, please create an issue.  
+If you can reproduce the problem in a branch you push to GitHub we will love you even more.
 
-Please check the issue list and if you do not find it mentioned there, please create an issue.
+We also have a [feature matrix](https://github.com/hyperstack-org/hyperstack/blob/edge/docs/feature_matrix.md), which is an attempt to list known issues and the current status.
+Having people expanding and maintaining this table would be excellent.
 
-## If you would like to contribute to this project
+## If you would like to fix a bug
 
-Please see the list of issues labelled 'Help Wanted' as a start. There is always tons to do so we would appreciate the help.
+Please ask in [gitter chat](https://gitter.im/ruby-hyperloop/chat) if you need pointers. There is always tons to do so we would appreciate the help.  
+You can see the list of GitHub issues labelled '[Help Wanted](https://github.com/hyperstack-org/hyperstack/issues?q=is%3Aopen+is%3Aissue+label%3A%22help+wanted%22)'
+or look at the [feature matrix](https://github.com/hyperstack-org/hyperstack/blob/edge/docs/feature_matrix.md) for things that have the status 'bugged'.

docs/installation/installation.md

@@ -2,6 +2,8 @@
 
 **Work in progress - ALPHA (docs and code)**
 
+### Current installation documenation is found in ./install/readme.md this file is outdated and should be removed.
+
 This template will create a new Rails app with Webpacker from Hyperstack edge branch
 
 ## Usage

docs/readme.md

@@ -35,8 +35,8 @@ You can be up and running in **less than 5 minutes**. Just follow the simple set
 
 + Setup and Installation: https://hyperstack.org/edge/docs/installation
 
-Beyond the installation we strongly suggest new developers work trough the [ToDo tutorial](https://github.com/hyperstack-org/hyperstack/blob/edge/docs/tutorial/todo.md).
-As it gives a minial understanding of the Hyperstack framework.
+Beyond the installation we strongly suggest new developers work trough the [todo tutorial](https://hyperstack.org/edge/docs/tutorials/todo).
+As it gives a minimal understanding of the Hyperstack framework.
 
 ## Community and support
 
@@ -52,12 +52,13 @@ Please see the [ROADMAP](https://github.com/hyperstack-org/hyperstack/blob/edge/
 
 ## Contributing
 
-We have a [Feature Matrix](https://github.com/hyperstack-org/hyperstack/blob/edge/docs/feature_matrix.md) that needs to be filled with missing features.
-The idea is that you can check here what the implementation status is of a Ruby (on Rails) feature.
-And if you have the time and skill you're more then encuraged to implement or fix one or two.
-But if you're not in a position to contribute code, just expanding and maintaining this table would be very excellent.
+In general, if you would like to help in any way, please read the [CONTRIBUTING](https://github.com/hyperstack-org/hyperstack/blob/edge/CONTRIBUTING.md) file for suggestions.  
+System setup for the development of Hyperstack itself is documented in this file.
 
-If you would like to help in any other way, please read the [CONTRIBUTING](https://github.com/hyperstack-org/hyperstack/blob/edge/CONTRIBUTING.md) file for suggestions.
+More specifically, we have a [Feature Matrix](https://github.com/hyperstack-org/hyperstack/blob/edge/docs/feature_matrix.md) that needs to be filled with missing features.
+The idea is that you can check here what the implementation status is of a Ruby (on Rails) feature.
+And if you have the time and skill you're more then encouraged to implement or fix one or two.
+But if you're not in a position to contribute code, just expanding and maintaining this table would be excellent.
 
 ## Links
 
@@ -68,11 +69,12 @@ If you would like to help in any other way, please read the [CONTRIBUTING](https
 
 ## License
 
-Released under the MIT License. See the [LICENSE][https://github.com/hyperstack-org/hyperstack/blob/edge/LICENSE] file for further details.
+Hyperstack is developed and released under the MIT License. See the [LICENSE](https://github.com/hyperstack-org/hyperstack/blob/edge/LICENSE) file for further details.
 
 ## History
 
-Hyperstack is an evolution of [Ruby-Hyperloop](https://github.com/ruby-hyperloop). We decided to rename the project to drop the Ruby suffix and also took the opportunity to simplify the repos and project overall.
+Hyperstack is an evolution of [Ruby-Hyperloop](https://github.com/ruby-hyperloop). We decided to rename the project to drop the Ruby suffix and also took the opportunity to simplify the repos and project overall.  
+Hyperloop was started by the developers of the reactrb gem.
 
 + Old website: http://ruby-hyperloop.org/
 + Old Github: https://github.com/ruby-hyperloop

docs/tutorial/todo.md

@@ -1,11 +1,16 @@
-# TodoMVC Tutorial (Rails 5.2.x)
+# TodoMVC Tutorial
+
+*Based on Ruby on Rails 5.2.x*
 
 ### Prerequisites
 
-{ [Ruby On Rails](http://rubyonrails.org/) }  
-{ [Yarn](https://yarnpkg.com/en/docs/install) }
++ Linux or Mac system  
+  (Android, ChromeOS and Windows are not supported)
++ Ruby on Rails must be installed: https://rubyonrails.org/
++ NodeJS must be installed: https://nodejs.org
++ Yarn must be installed: https://yarnpkg.com/en/docs/install
 
-### The Goals of this Tutorial
+### The goals of this tutorial
 
 In this tutorial, you will build the classic [TodoMVC](http://todomvc.com) application using Hyperstack.
 This tutorial will demonstrate several key Hyperstack concepts - client side Components and Isomorphic Models.

install/readme.md

@@ -1,22 +1,34 @@
 # Hyperstack Rails Template
 
-This template will create a new Rails app with Webpacker from Hyperstack edge branch
+**This will create a new Rails app with Webpacker and the current released Hyperstack gems by running the installation template in the edge branch.**
+
+## Prerequisites
+
++ Linux or Mac system  
+  (Android, ChromeOS and Windows are not supported)
++ Ruby on Rails must be installed: https://rubyonrails.org/
++ NodeJS must be installed: https://nodejs.org
++ Yarn must be installed: https://yarnpkg.com/en/docs/install
 
 ## Usage
 
 Simply run the command below to create a new Rails app with Hyperstack all configured:
 
+```shell
+rails new MyAppName --template=https://rawgit.com/hyperstack-org/hyperstack/edge/install/rails-webpacker.rb
 ```
-rails new MyApp -m https://rawgit.com/hyperstack-org/hyperstack/edge/install/rails-webpacker.rb
-...or
-rails new MyApp -m rails-webpacker.rb
+Alternativly, if you like you can also download [the template file](https://rawgit.com/hyperstack-org/hyperstack/edge/install/rails-webpacker.rb) (the part after `--template=`) and read the contents,
+it shows how a Hyperstack Rails project differs from a plain Rails project.
+The downloaded file can then be referenced from the local filesystem.
+```shell
+rails new MyAppName --template=rails-webpacker.rb
 ```
 
 ## Start the Rails app
 
-+ `foreman start` to start Rails and OpalHotReloader
-+ Navigate to `http://localhost:5000/`
++ Run `foreman start` from a console to start the Ruby on Rails server and Opal HotReloader
++ Navigate to http://localhost:5000
 
-## Pre-Requisites
+### Tutorial
 
-+ Yarn must be installed (https://yarnpkg.com/en/docs/install#mac-stable)
+If you are new to developing an application based on Hyperstack we suggest you follow the [todo tutorial](https://hyperstack.org/edge/docs/tutorials/todo).