Developing a Documentation Portal on Heroku


Published on

  • Be the first to comment

  • Be the first to like this

No Downloads
Total views
On SlideShare
From Embeds
Number of Embeds
Embeds 0
No embeds

No notes for slide

Developing a Documentation Portal on Heroku

  1. 1. Developing a Documentation Portalon HerokuSteve Anderson,, Information Architect@sanderson_sfdc
  2. 2. Safe Harbor Safe harbor statement under the Private Securities Litigation Reform Act of 1995: This presentation may contain forward-looking statements that involve risks, uncertainties, and assumptions. If any such uncertainties materialize or if any of the assumptions proves incorrect, the results of, inc. could differ materially from the results expressed or implied by the forward-looking statements we make. All statements other than statements of historical fact could be deemed forward-looking, including any projections of product or service availability, subscriber growth, earnings, revenues, or other financial items and any statements regarding strategies or plans of management for future operations, statements of belief, any statements concerning new, planned, or upgraded services or technology developments and customer contracts or use of our services. The risks and uncertainties referred to above include – but are not limited to – risks associated with developing and delivering new functionality for our service, new products and services, our new business model, our past operating losses, possible fluctuations in our operating results and rate of growth, interruptions or delays in our Web hosting, breach of our security measures, the outcome of intellectual property and other litigation, risks associated with possible mergers and acquisitions, the immature market in which we operate, our relatively limited operating history, our ability to expand, retain, and motivate our employees and manage our growth, new releases of our service and successful customer deployment, our limited history reselling products, and utilization and selling to larger enterprise customers. Further information on potential factors that could affect the financial results of, inc. is included in our annual report on Form 10-Q for the most recent fiscal quarter ended July 31, 2012. This documents and others containing important disclosures are available on the SEC Filings section of the Investor Information section of our Web site. Any unreleased services or features referenced in this or other presentations, press releases or public statements are not currently available and may not be delivered on time or at all. Customers who purchase our services should make the purchase decisions based upon features that are currently available., inc. assumes no obligation and does not intend to update these forward- looking statements.
  3. 3. Even the Simplest UINeeds Documentation
  4. 4. Creating a Help SystemTakes Time Away FromYour Project
  5. 5. Let Us Do It For You!
  6. 6. Heroku Doc Portal
  7. 7. Hosted on Heroku
  8. 8. Written in Ruby
  9. 9. Contents stored inCouchDb
  10. 10. Search powered by Solr
  11. 11. Format controlled byoocss
  12. 12. Project available ongithub
  13. 13. Upload Your HTML, Add aTable of Contents Writtenin JSON, and You’reReady to Go
  14. 14. Demo
  15. 15. Let’s dig in
  16. 16. Keeping it simple Everything is done using RESTful HTTP actions
  17. 17. Sinatra• Domain Specific Language (DSL) for defining RESTful HTTP actions• Every time a user visits a URL, a Sinatra route is triggered• Each route returns something to the browser• The content returned can be • a HTML file from CouchDB, • a simple page defined using HAML, • a search results page that displays the SOLR data, or • a static page
  18. 18. A Simple Sinatra Route
  19. 19. A More Interesting Sinatra Route
  20. 20. Sinatra Supports Complex Routes
  21. 21. Views HAML (HTML Abstraction Markup Language ) is used to define the views
  22. 22. CouchDB for Content Storage• CouchDB is a document database• The data is saved in a semi-structured key/value store• Advantages of a document database for this project • The data isn’t restricted by a schema • Queries aren’t limited by the keys • Use views for powerful data access• Provided by Cloudant, CouchDB in the cloud• Integrated with the application using couchrest_model
  23. 23. Define the Model
  24. 24. Document in CouchDB
  25. 25. Views in CouchDB
  26. 26. Retrieve Using a View
  27. 27. Let’s Put It All Together
  28. 28. Solr for Search• Open source enterprise search platform from the Apache Lucene project. • full-text search • hit highlighting • faceted search• Powered by WebSolr, Solr in the Cloud• Integrated with the application using Sunspot
  29. 29. Solr Schema
  30. 30. Search with Solr
  31. 31. Search Flow
  32. 32. Look and feel - oocss• Oocss (Object-Oriented CSS) is a BSD licensed CSS framework• It’s very easy to swap in your own favorite CSS framework•
  33. 33. Static Files• PDFs, images for your CSS, JavaScript, etc.• All are stored in the file system
  34. 34. What About the Table of Contents and SearchFacets?• Each topic has an associated JSON (JavaScript Object Notation) file stored in CouchDB.• The facets are in a static JSON file• They are displayed using Dynatree, a JQuery plugin
  35. 35. Steve AndersonInformation Architect, @sanderson_sfdc