Rholang web - 0.1.1 release plan
Milestones
| Start date | 1 Jan 2018 |
|---|---|
| Sprint | date |
| Sprint | date |
| Release from development | date |
| Membership demo | date |
| Release | TBD |
Development team
| Development lead | Program manager | Project manager | Developer | Developer | DevOps | Page owner |
|---|---|---|---|---|---|---|
| Kyle Butt | Medha Parlikar (Unlicensed) | Jeremy Busk | Medha Parlikar (Unlicensed) |
Stakeholders
| Name | Role | Reviewed? |
|---|---|---|
| Lucius Meredith | CEO - RChain coop | |
| Nash Foster | CEO - Pyrofex |
Marketing team
| Marketing lead | Evangelist | Content owner |
|---|---|---|
| Lawrence Lerner |
Release summary
Simple overview
This release provides a mechanism for users to author Rholang smart contracts, compile and run these contracts via a Web interface
Technical overview
Metric for tracking success
Done when:
- Rholang web sandbox is distributable using a Docker image
- Tutorial is published with specific examples that appear in the drop down, and Mercury samples do not appear.
- Users are able to create and save contracts.
- The branding of the web compiler matches RChain branding (black and red at least)
What is special about this release?
Are we doing something differently? If so, why are we doing it this way?
Before these features were available, what were developers able to do with RChain?
After these features launch, what will developers be able (and not able) to do with RChain?
Description of release packaging
Where do developers go to learn more and get started?
Where will bugs be filed?
Where do developers go for support? What is the SLA? Who is on point?
What license will this be released under?
Launch readiness review
Is the code of high quality?
Has it been tested
What is the test program
Michael Stay (Unlicensed): Example contracts tested with compiler
- Medha Parlikar (Unlicensed): Example contracts tested in web Compiler & run in C++ Rosette
- Michael Stay (Unlicensed): Tutorial code snippets tested with compiler
Are there any known issues with the product? Yes
Are these documented? - Yes - on Github
Are any of the known issues blockers? - No
Does the release build via CI nightly?
- Rholang Compiler
- Rosette
- Rholang Web
Have built what we set out to build at the onset? Does the release match what we have communicated in the launch plan?
Is documentation ready?
- Installation instructions for Docker- Web Compiler - example: https://store.docker.com/community/images/rchain/rchain-comm
- Installation instructions for Docker - SDK
- Updated rholang/ReadMe.MD on Github for changes recently made
- Update rholang/ReadMe.MD on Github for SDK download & Run instructions
- Update rholangweb/Readme.MD to include docker run information.→ Deferred
License the code will be released under. GPL v2: http://openjdk.java.net/legal/gplv2+ce.html
- Support program
- Developer Forum. Will need the URL in the release page & Github. - Forum coming soon - need a date when it will be ready.
- Link to file issues: https://rchain.atlassian.net/secure/CreateIssueDetails!init.jspa?pid=10105&issuetype=10103&versions=10012&components=10004&assignee=medha&summary=issue+created%20via+link
Show the release to the membership
Trial run: In Dev Standup with Greg
Forum: Community hangout
Review documentation about the release
Demo to Members
- Merge to Master
- Cut the release in Github
Create Docker download link
Publish to the web & Community
Docker instructions:
rchain/rholang-web
The compile-and-run pipeline has been packaged up for use as a web application. This application is also made available via docker, so that individuals may run it locally.
docker run -ti --net host rchain/rholang-web
will cause a web server to listen on port 8000, which a browser can reach at localhost:8000.
Note on ports
It has been reported that the default port of 8000 may not work in all cases. Docker has an on-again-off-again relationship with local networking, having been designed for service-level, cloud computing. To try to alleviate some networking pain, the container accepts a single argument (after the image name) that tells it on which port to listen. For example, using host networking (usually the simplest) and port 80 (the normal port for HTTP traffic):
docker run -ti --net host rchain/rholang-web 80
causes the webserver to look "normal" to a browser, so going to localhost may work.
Another alternative to try, if that fails on your machine, is to use docker's own networking and expose the port
docker run -ti -p 80:80 rchain/rholang-web 80
which has been reported to work better in some cases.
JIRA issues in this release