Developer Documentation Portal

This is the 178 working version of the developer documentation portal, a heroku based application for delivering content to salesforce, force.com, and database.com developers.

See it Live

Username: devdoc Password: test1234

Requirements

• Ruby 1.9.2 To install the required gems, use bundle install
• CouchDB
• Solr
• memcached

Process

1. Update globals.rb to match your environment.
2. Run rake update_local_db
3. Run rake start_local_with_foreman
4. Open your web browser to view the site.

Updating heroku

To update heroku, run rake update_remote_db

Rake

There are other options in the Rakefile, including an option to run locally against the remote database and search index. Run rake -T to see all the commands.

Next steps [4/7]

These are the things that need to be done for 178.

[#A] Close or push all bugs

Finish up the type facets

[#B] Fix styles for shortdesc on landing page

[#A] Fix guide links on search results page

[#C] Send labels for localization [/]

Update all the haml files to make labels out of everything

Figure out what Evelyn was talking about in her labels question

Add link to r18n in the comments

Add link to yaml in the comments

[#C] Set up Ranger report status of site (Ranger?), or figure out how to work with logentries

[#C] New Relic

[#B] Blitz test?

Figure out the tags and filters text

Update docbuild [3/5]

Drop /js/functions.js

Drop onLoad

Remove ${CSS.PATH}help.css from the build

VERIFY Set feedback=false by default

VERIFY Update on_server links

Drop help.css links?

Long term

Things to do after 178

See if Jenkins supports Rake

Write a rake file to [1/4]

Build the doc

Push the content into the database

Run automated tests on local system

Monitor remote [2/4]

Q: Can this be done on a server running on my linux box?

Q: Maybe use pulse for this, too.

Fix deliverable level metadata [0/1]

Create a json file to upload to couch as part of the build that has all the metadata for the deliverable

Push an identifier for the deliverable into the topic document

Create a helper to pull the content out

Q: Will this result in a lot more network traffic? Is it worth it?

Report last update in CouchDB

This is likely easiest to do by setting up a view on the DB using couchrest

Generate the landing page

Document how other people can use our repository

Support mobile by rewriting haml, or maybe just the CSS

Write a “clean-up” method to remove old documents

Figure out feedback options

Update local schema from Solr schema to get spelling check

Set up sounds like (see http://blog.websolr.com/)

Update Routes [/]

Route for dbcom/locale/<api_version>/topicname

Validate lang/local

Valid api_versions only

Validate lang/loc

Route for dbcom/locale/<patch_version>/topicname

Valid patch_versions only

Route for dbcom/local/<api_version>/<patch_version>/topicname

Validate lang/locale

Valid patch_versions only

Valid api_versions only

Route for dbcom/topicname

Return en-us and latest patch version

Fix the directory structure

Find out good patterns