Skip to content
This repository has been archived by the owner on May 8, 2020. It is now read-only.

Commit

Permalink
feat(documentation): Added roadmap and alpha notice to homepage
Browse files Browse the repository at this point in the history
  • Loading branch information
zakhenry committed Jun 13, 2016
1 parent eaff674 commit 3ac1dcb
Show file tree
Hide file tree
Showing 4 changed files with 78 additions and 12 deletions.
2 changes: 1 addition & 1 deletion docs/api.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,5 +9,5 @@ layout: api-container.hbs
## Error
Typedoc output not found. Have you run the generator?
```bash
$ u doc:api
$ u typedoc
```
57 changes: 56 additions & 1 deletion docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,4 +2,59 @@
layout: home.hbs
title: Ubiquits
description: Full stack isomorphic typescript framework.
--------------------------------------------------------
---

## Roadmap

### Alpha release (feature complete) [TBC]
- [ ] Angular Universal (server side prerendering) integration
- [ ] Docker deployment
- [ ] Database migrations
- [ ] Email sending
- [ ] Custom middleware registration
- [ ] Queue handling
- [ ] Database seeding from `MockModelProvider`s
- [ ] Full validation decorator complement
- [ ] 100% Code coverage

### Developer Preview [June 17th]
- [ ] Model hydration and mocking
- [ ] `BaseResourceController` implementation with CRUD routes
- [ ] Post-initialization cli tour
- [ ] Full stack demo in quickstart
- [ ] Feature page in docs
- [ ] FAQ page in docs

### Sprint 0 [June 10th]
- [x] Full stack proof of concept
- [x] Backend dependency injection with `@angular/core`
- [x] Angular 2 compiling with webpack
- [x] `webpack` watcher for browser & common changes with livereload
- [x] `nodemon` watcher for server & common changes
- [x] Compilation to es2015 for browser on build
- [x] Compilation to es2015 for api on build
- [x] Output consumable by `typings`
- [x] Source mapping for api debugger
- [x] Full stack debug breakpoints in Webstorm
- [x] Live reloading browser
- [x] Live restarting server
- [x] Route registration with `@Action` decorator
- [x] `docker-compose.json` running postgres db
- [x] Connection to database from localhost with `Sequelize`
- [x] Testing framework for both frontend and backend
- [x] Travis Ci automated testing
- [x] Coverage results remapped to typescript, pushed to coveralls
- [x] Abstract and concrete `@injectable` implementation of `Logger` class/interface
- [x] Automated deployment to npm registry with version bump
- [x] Commandline interface
- [x] `vantage` cli task runner integrating with `gulp` and `metalsmith` tasks
- [x] Configuration file in parent project
- [x] Extendable commands
- [x] Shell connection to server runtime context
- [x] Runtime task registration
- [x] Initialization of new projects (quickstart)
- [x] Documentation framework
- [x] File watcher/livereload server
- [x] Typedoc integration
- [x] Extendable styles, templates, assets
- [x] Default collections for automatic navigation generation
27 changes: 19 additions & 8 deletions docs/templates/home.hbs
Original file line number Diff line number Diff line change
Expand Up @@ -22,8 +22,6 @@
<div class="parallax"><img src="/assets/image/title-card.jpg" alt="Unsplashed background img 1"></div>
</div>


<div class="container">
<div class="section">

<!-- Icon Section -->
Expand All @@ -39,24 +37,37 @@

<div class="col s12 m4">
<div class="icon-block">
<h2 class="center grey-text"><i class="material-icons">assignment</i></h2>
<h5 class="center">Self Documenting</h5>
<h2 class="center grey-text"><i class="material-icons">widgets</i></h2>
<h5 class="center">Full stack components</h5>

<p class="light">By leveraging <a href="http://typedoc.io">Typedoc</a> and <a href="http://metalsmith.io">Metalsmith</a>, generating documentation for consumers of your component is a breeze.</p>
<p class="light">Having components defined by their problem domain, not their position in the stack allows for plugin developers to create full stack plugins, with simple installation</p>
</div>
</div>

<div class="col s12 m4">
<div class="icon-block">
<h2 class="center grey-text"><i class="material-icons">widgets</i></h2>
<h5 class="center">Full stack components</h5>
<h2 class="center grey-text"><i class="material-icons">assignment</i></h2>
<h5 class="center">Self Documenting</h5>

<p class="light">Having components defined by their problem domain, not their position in the stack allows for plugin developers to create full stack plugins, with simple installation</p>
<p class="light">By leveraging <a href="http://typedoc.io">Typedoc</a> and <a href="http://metalsmith.io">Metalsmith</a>, generating documentation for consumers of your component is a breeze.</p>
</div>
</div>
</div>

</div>

<div class="card grey darken-3">

<div class="card-content white-text">
<span class="card-title">
<i class="material-icons">build</i> Ubiquits is currently in <a href="https://en.wikipedia.org/wiki/Software_release_life_cycle#Pre-alpha">pre-alpha phase</a> and being actively developed.
</span>
<p>See the <a href="#roadmap">roadmap below</a> to see the planned release schedule. Keep up to date by following <a href="https://twitter.com/ubiquits">@ubiquits</a> on Twitter</p>
</div>
</div>

<div class="container">
<div class="contents">{{{ contents }}}</div>
</div>

</main>
Expand Down
4 changes: 2 additions & 2 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -49,9 +49,9 @@
"zone.js": "^0.6.12"
},
"devDependencies": {
"@ubiquits/toolchain": "^0.1.10"
"@ubiquits/toolchain": "^0.1.11"
},
"directories": {
"doc": "docs"
}
}
}

0 comments on commit 3ac1dcb

Please sign in to comment.