This is the roadmap document for the tlks.io project. It describes the remaining work to do until version 1.0.
It is a live document, it means that changes on this spec are and will be comming if it is necessary. Nothing is fixed or closed unless we excplicity say the contrary. So please put everything in doubt and keep the discussion alive ;)
This document follows an idea started by Ubuntu, which consists in planning a great but difficult bug 0 (our 1.0 version) to solve, so all minor versions & milestones should refer this one and solve an small task and part of it.
For transparency into our release cycle and in striving to maintain backward compatibility, all project components are maintained under the Semantic Versioning guidelines. Sometimes we screw up, but we'll adhere to those rules whenever is possible.
We also follow the rule that one issue fixed should be a new minor release, so expect to have a lot of minor version numbers changes, this will be normal.
Easy or not? ;)
- We rock! ( we always do )
- We have been spotted at producthunt.com ( difficult )
- We have been spotted on reddit ( easy )
- We have at least 1000 registered users
- We have at least 25 active users
Lets work on a first MVP ( Most Viable Product ) to build a base project to grow. Minimal features should be:
- Popular & Latest talks
- RSS popular & latest talks
- Browse talks by tag
- RSS talks by tag
- Search talks
- Upvote a talk by registered users
- Favorite / Unfavorite talks by registered users
- Count views for each talk
- Talk detailed view
- Share a talk on Twitter ( twitter cards )
- Share a talk on Facebook ( facebook opengraph )
- Share a talk on Google+ ( G+ snippets )
- Share a talk on Pinterest ( Pinterest rich media )
- Related talks to another talk snippet ( for detailed view ).
- Support only Youtube videos
- Auth and user registration throught Twitter OAuth
- Publish a new talk ( how to dectect duplicates? )
- Comments by disqus
- Activity list
- Private settings for registered users
- Public profile for registered users
- Public Profile : Published talks list
- Public Profile : Upvoted talks list
- Public Profile : Favorited talks list
- Corporate pages like About, Terms, Policty, FAQ etc ...
- 100 talks published
- Paginate popular talks
- Paginate latest talks
- Paginate published talks on profile
- Paginate upvoted talks on profile
- Paginate favorited talks on profile
We finished our MVP. Now it is time to work on SEO and basic metrics.
Finally as a new features we will introduce following and followers to our users.
- SEO ( Jose is your turn, document before start working! )
- Create subproject's technical documentation
- Specify all amount of work needed only based on the current platform
- Do not think on future tasks. SEO will always be revisited
- Add developer environment on chef deployment scripts
- Add databag with a single configuration on chef
- On developer environments
- On production environments
- Encrypt databag configuration and add this encrypted file to github
- using each developer ssh-key? coool!
- or a single one? meh ... :\
- Generate deployed projects configuration with chef
- use previous databag file.
- Populate database with chef
- On developer environments
- Using db project backup
- Get database configuration from the encrypted databag
- Popuplate index using chef
- On developer environments
- Using previously populated database
- Get index configuration from the encrypted databag
- Minimize all javascript scripts used on production automatically.
- Add support for javascript source maps for development.
- Karma : Algorithmic popularity calculation
- New home layout, daily timeline sorted by karma like producthunt.com
- Paginate or Continuous scroll?
- Support Vimeo videos
- Share a talk by mail
- Share a talk by sms
- Watch later
- CSRF on add form
- CSRF on profile form
- Search for profiles (people)
- Paginate watch later on profile?
- Mark/Show already watched talks on results?
- Paginate already watched on profile?
- Fetch extra information from the talk (youtube api? xml feed? discuss it)
- Duration
- Tags
- Updated + Created
- Stats: Views + Favorites
- Ratomg: Liked + Dislikes
- Add slides external link to a talk (optional? discuss it)
- Metadata! (google search? discuss it. May we use schema? )
- Microformats! (check http://microformats.org )
- Users: Following / Followers
- Public Profile: Following users list
- Paginate following users on profile
- Public Profile: Followers users list
- Paginate follower users on profile
- Modify the youtube player for adding features like "whach it later", can we do that?
- Show publisher of the talk and its publication date
- Clicking play on youtube player should increase views on the talk
- Show upvoters on detailed talk view
- Activity should show only followers data, this view will be only for registered users.
Microservices! Microservices!
This is mostly work on Shiva subproject and refactoring the current platform in favor on a distributed & microservices based architecture.
Another important part to work on this milestone is on the caché, we must caché everything we can. We need our MVP as fast as hell!
- Revisit SEO
- SEO for profile followers
- SEO for profile following
- Document the architecture of our distributed system.
- Implement 0.1 version of tlks.io distributed system.
- Message bus
- Event Manager
- Queue System
- Indexing Microservice
- Define events
- Define payloads
- Create producer?
- Create consumer that index new published talks on elasticsearch
- Promotion Microservice
- Define events
- Define payloads
- Create consumer that promotes new talks on Twitter
- Create consumer that promotes new talks on Facebook
- Create consumer that promotes new talks on Google+
- Create consumer that promotes new talks on Pinterest
- Notification Microservice
- Define events
- Define payloads
- Which consumers we need?
- Caché everything! ( We should discuss a lot this one, subproject? )
- Varnish? NO! big and too easy :\
- Redis?
- Elastic?
- MongoDB?
- Multi-Level custom caché? ( I vote for this one ) YES!
Enough rock for now, lets make this MVP as solid as Metal. \m/
We will ensure that we have a proper test environment and we will build basic tests for UNit, Integration and End to End layers. We will also execute those tests periodically on each component throught TravisCI and coveralls.io.
As a new feature we will intrdocuce collections of talks to our users.
- Collections of talks per user ( see collections at producthunt.com )
- Add a talk to a collection from the detailed view
- Add a talk to a collection from any list view
- Public Profile: Collections list
- Proper Unit Testing suite.
- Proper End to End Testing suite.
- Front-end tests via phantomjs.
- Everything on a CI, in our case TravisCI
- Public code coverage reports using coveralls.io
- Public search documentation syntax ( section help? )
- Enhaced search query : AND operator
- Enhaced search query : OR operator
- Enhaced search query : Wildcard operator
- Enhaced search query : Phrase search
- Enhaced search query : Word filters with '-' and '+' modifiers
Feedback, Notifications & Devop time!
TODO: This should be discussed!
- Email notifications to users.
- Sendgrid?
- How to trigger? Queues again?
- Just repeat 0.3.0 but for this new microservices arquitecture.
- Rethink deploy system.
- Still with Chef? (I like it)
- Docker? ( Our hosting doesn't support it, change to DigitalOcean? )
It starts to look as a platform! Now time to think a little bit more, make this project reliable:
TODO: This should be discussed!
- Rethink storage At this point using a free MongoDB service could not be enough.
- Rethink search Same than above, we are using a free bonsai.io instance.
- Benchmarks and usage metrics.
- How many users we can support with the current resources?
- How much will cost to escalate it?
- Risks?
Ok we have a rock solid platform. Make it pretty, bitch!! :*
TODO: This should be discussed!
- New logo
- New layout & design
- Responsive! At least Desktop, Tablet and High End phones.
TODO: This should be discussed!
- Just repeat 0.3.0 but for this new layout & design.
- Rethink client-side.
- Continue with Jade & JQuery? ( probably )
- React?
- AngularJS?
- Benchmarks and usage metrics on the client side.
- How many users we can support with the current resources?
- How muh will cost to escalate it?
- Risks?
TODO: This should be discussed!
- Featured collections
- Public detailed view for user collections
- Landing page / detailed view for featured collections
- SEO for Landing feature collection pages
- Subdomain? http://pr0n.tlks.io (don't like it)
- Canonical? http://tlks.io/pr0n-talks ( yes! yes! )
- Tune, tweak the platform and prepare the 1.0 version