Skip to content

Commit 206e72f

Browse files
barriehadfieldbarriehadfield
committed
updated docs, install and hyperstack version
1 parent a09bc60 commit 206e72f

34 files changed

Lines changed: 1922 additions & 1005 deletions

‎CONTRIBUTING.md‎

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
# Contributing to this project
2+
3+
We welcome and encourage contribution and would be delighted if you participated in this project.
4+
5+
## If you think you can improve the docs
6+
7+
Each page on the website has an 'Improve this page' button which will create a PR against the correct file and the correct branch.
8+
9+
## If you think you can improve the website
10+
11+
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.
12+
13+
## If you find a bug
14+
15+
Please check the issue list and if you do not find it mentioned there, please create an issue.
16+
17+
## If you would like to contribute to this project
18+
19+
Please see the list of issues labelled 'Help Wanted' as a start. There is always tons to do so we would appreciate the help.

‎HYPERLOOP_VERSION‎

Lines changed: 0 additions & 1 deletion
This file was deleted.

‎HYPERSTACK_VERSION‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
1.0.0.alpha1

‎LICENSE‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
MIT License
22

3-
Copyright (c) 2018 Hyperloop.org
3+
Copyright (c) 2015 - 2018 Yi-Cheng Chang, Mitch VanDuyn, Adam Creekroad, Barrie Hadfield, Jan Biedermann
44

55
Permission is hereby granted, free of charge, to any person obtaining a copy
66
of this software and associated documentation files (the "Software"), to deal

‎ROADMAP.md‎

Lines changed: 70 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,70 @@
1+
# Hyperstack 1.0
2+
3+
## Top-level project goals
4+
5+
+ One language for all code (which is Ruby for now)
6+
+ Avoiding repetitive and boilerplate code.
7+
+ Use convention over configuration where possible.
8+
+ Class definitions that are internally consistent, and stable over time.
9+
+ Class definitions that act like existing well known structures.
10+
+ As friction free as possible configuration and development tool chain.
11+
+ Good documentation, and a helpful community, both for users, and contributors.
12+
+ A professional, well structured code base, complete test coverage, and automatic continuous integration.
13+
+ Implementation should be as efficient both in speed and space as practical given the above.
14+
15+
## Roadmap
16+
17+
### Hyperloop (!!) version 0.99 - final Hyperloop version
18+
19+
#### mission: release the functionality of current hyperloop edge branch
20+
21+
+ ~~move current gem set to one repo under hyperstack (done - tx Barry)~~
22+
+ ~~get specs to pass with current names (done - tx Mitch and Johan)~~
23+
+ ~~release under old hyperloop gem names version 0.99~~
24+
+ ~~publish to hyperloop-legacy branch *(not master)* with tag 0.99~~
25+
+ update old website
26+
27+
------
28+
29+
### Hyperstack version 1.0.0.alpha1
30+
31+
#### mission: move to new naming conventions
32+
33+
+ rename modules and classes per new naming conventions
34+
+ include a deprecation module
35+
+ document upgrade path
36+
+ release under new gem names with version 0.1
37+
+ tag as master version 0.1
38+
+ release new website with updated docs
39+
+ clearly document (in hyperloop repo and old website) that we have moved
40+
41+
### version 0.2
42+
43+
#### mission: Integrate OWL (Opal-Webpack-Loader)
44+
45+
+ document install and usage instructions for OWL, and lazy loading
46+
+ release and tag as master version 0.2
47+
48+
### version 0.3
49+
50+
#### mission: make independent of Rails
51+
52+
+ details TBD, may include restructure of gems as client and server adapters
53+
+ document upgrade instructions
54+
+ release and tag as master version 0.3
55+
56+
### version 0.4 ... as needed until all APIs, DSLs, configuration mechanisms, and semantics are stable
57+
58+
------
59+
60+
### version 1.0.rc1
61+
62+
#### mission: first attempt at the 1.0 release
63+
64+
### version 1.0.rc2 … etc
65+
66+
#### mission: bug fixes until ready to release
67+
68+
------
69+
70+
### version 1.0

‎docs/docs_overview.md‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
# Welcome to Hyperstack!
2+
3+
**Hyperstack is work-in-progress. Please consider everything in this repo as ALPHA.**
4+
5+
Hyperloop (version 0.9) is stable, and the existing website remains in place. If you are looking for a production ready project, then please stay there until this is released. http://ruby-hyperloop.org
6+

0 commit comments

Comments
 (0)