BBC-News/wally — pull request #4 by lenny (2012-08-03 20:09:08+00:00)
Title: client gem, hierarchical topics, markdown readme files, .nav support, etc..

Hi,

I've been experimenting with Wally as an internal feature documentation server. I was looking at Relish, but I love the idea of having something simple that can be deployed internally. Wally looked great but it was missing some key features afaiwc. Anyway, I did some admittedly aggressive hacking to bring some of Relish's more essential features to Wally.

* wally-client - See: features/wally-client/*

I had to change the strategy for pushing content to Wally in order to support extra content like .nav and readme files. I split out the client gem primarily to lighten up the dependencies needed to talk to Wally. The new client implementation provides a command line Thor script.

$ bundle exec wally-client
Tasks:
wally-client add_project NAME # Add project
wally-client help [TASK] # Describe available tasks or one specific task
wally-client push PROJECT DIR # Push features from DIR to PROJECT
wally-client remove_project NAME # Remove project

* Hierarchical navigation - See: features/hierarchical_topic_navigation.feature
* Customizing topic navigation with .nav file - See: features/customize_topic_navigation.feature
* Markdown readme pages - See: features/readme_pages.feature

Also, some scenario related items were missing - See the new scenarios below in features/scenario_page.feature
* Scenario: Single cell data table
* Scenario: Scenario description
* Scenario: Doc strings

Notes:
* I dropped the parameter based authentication for now as it was getting in the way and I was thinking that authentication
would be better off implemented using some kind of authentication keys/tokens. Including a single password in the URL didn't seem
to offer much.
* I started a fairly crude configuration scheme that sets configuration using a yaml file. (e.g mongo_url, etc..) See config/wally.yml read by wally/application.rb
* I didn't published the wally-client gem. If you're interested in pulling, it would preferably live under the wally namespace. For now, I had been developing using the :path option in my wally/Gemfile.

For now it is at https://github.com/lenny/wally-client

-lenny