The JavaScript @PubNub Documentation is ready to be updated. We need an engineer to revamp our JavaScript docs.
This Project Requires Knowledge In:
– JavaScript
– HTML
The most up-to-date docs are located here: http://www.pubnub.com/account-javascript-api-include
You must have a Twitter account to communicate with us during your documentation. This is important. We need to keep in touch with you. Using Twitter for this is a *requirement*. You will likely have many questions. To start the project, you must tweet a project kickoff message for @PubNub.
The most important part will be to Read Source Code for PubNub JavaScript starting here:
https://github.com/pubnub/pubnub-api/blob/master/javascript/pubnub-3.1.js#L551
Out of date documentation may be found here:
http://www.pubnub.com/tutorial/javascript-push-api
And here:
http://www.pubnub.com/tutorial/developer-intro-tutorial
And here:
http://www.pubnub.com/blog/build-real-time-web-apps-easy
The Deliverable:
– Full documentation with response codes and expected behavior.
– A walk-through of how to use each feature.
– The Walk-through and Documentation are Two Separate HTML files.
– Screenshots for the walk-through of response output/input.
The Functions to cover in the PubNub JS API:
– Publish: PUBNUB.publish({…})
– channel
– message
– callback(info)
– Subscribe: PUBNUB.subscribe({…})
– channel
– callback(message)
– connect
– error
– Unsubscribe
– channel
– History: PUBNUB.history({…})
– channel
– limit
– callback(messages)
– Analytics: PUNBUB.analytics({…})
– channel
– limit
– ago
– duration
– callback(data)
– Time
– callback(time)
– UUID
– callback(uuid)
– Init: var net = PUBNUB.init({…});
– *** this function is an OPTIONAL utility for multi-account support. ***
– publish_key
– subscribe_key
– ssl
– origin
Utility functions are needed to make PubNub work:
– each
– map
– css
– $
– create
– bind
– supplant
– search
– attr
– now
The Guidelines:
– Each API function documented must identify/include:
– Default Params.
– Required vs Optional Params.
– Response Codes + Meaning.
– Expected Behavior.
– Column width is 600px. The documentation must not exceed 600px width.
– Deliver docs in HTML only. CSS won’t be necessary.
– For code examples, use https://gist.github.com/ GitHub Gists (with the EMBED feature).
– Screenshots for walk-through must be 600px wide.
– The Walk-through and Documentation are Two Separate Deliverables.
– You may repost these docs. Anywhere is okay, like on your own website/blog or otherwise is great.
Information on PubNub:
http://www.pubnub.com/ website and follow on twitter @PubNub to learn more.
PubNub is a Web Push Engine. PubNub is able to push (or stream) any textual data in real-time to any types of clients across the Internet. PubNub solves the complexity of pushing data in a scalable, efficient, secure, reliable and portable way. On the client side, APIs are provided so that it is very easy to build Bidirectional Networked Apps (transforming your existing client or creating a new one from scratch). A powerful Web 2.0 library makes it possible to push data updates to Mobile Phones, Tablets and Web Pages in real-time through a zero-install client. Objective-C, Java, PHP, JavaScript, Ruby, Python, Erlang and more are provided for mobile phones such as Android and iPhone, tablets such as iPad and XOOM. Every web browser is supported for web browser push.
Basically, PubNub can be considered a publish/subscribe middleware based on HTTP protocol.
