Hi folks, Short version:
Postponing major changes to README until essex-2, but am fixes any significant errors in essex-1. Please review: https://review.openstack.org/#change,1451 Dan Long version: As I mentioned at the meeting, I've had a bug file against essex-1 to simplify the README to avoid duplication with the main docs ( https://bugs.launchpad.net/quantum/+bug/875995). The main goal here is that the README was getting out of date relative to the main quantum docs on docs.openstack.org and in general having two places to update when something changes is a bad idea (keeping even one set of docs updated is challenge enough). Looking at Nova, they have updated their README to point to mainly to web pages, so I think there is good precedent here. Right now, the README is partially a user/administrator, partially a developer guide. Here is a summary of what is covered in the README, along with thoughts on where this content is (or should be) covered. - what is quantum (in API and Admin guide, will be in developer docs) - source code layout (will be in developer docs) - dependencies (in Admin guide) - running + installing quantum (in Admin guide, though needs to be expanded with new install options) - enabling a particular plugin (in Admin guide) - running quantum, again (in Admin guide) - example CLI usage (in Admin guide) - enabling keystone middleware (should be added to Admin guide now that it is in essex-1) - writing a Quantum plugin (will be in developer docs) - creating extensions (will be in developer docs) - building packages (probably in developer docs) If anyone has other feelings about where various topics are or should be covered, please chime in. There are a few hiccups in refactoring the README right now: 1) Ideally we would like to be able to have a "trunk" version of the documentation for users that are picking up essex milestone releases, without destroying the stable "diablo" version of the docs currently available on docs.openstack.org. I'm working with Anne to be able to have two versions of the docs, but its not available yet. 2) We don't have official developer docs yet. All we have is a wiki page http://wiki.openstack.org/QuantumDevelopment . We may decide that the wiki is good enough for now, but I wanted to see if anyone wanted to volunteer to create more formal developer docs. With these issues in mind, I decided to delay the full revamp of the README until essex-2, once we can resolve the above issues. In the mean time, I have pushed a review that leaves most of the content in the README, but fixes the most obvious of the issues (out of date paths, etc.). Would be great to have some quick reviews: https://review.openstack.org/#change,1451 Thanks! Dan -- ~~~~~~~~~~~~~~~~~~~~~~~~~~~ Dan Wendlandt Sr. Product Manager Nicira Networks: www.nicira.com cell: 650-906-2650 twitter: danwendlant ~~~~~~~~~~~~~~~~~~~~~~~~~~~
-- Mailing list: https://launchpad.net/~netstack Post to : netstack@lists.launchpad.net Unsubscribe : https://launchpad.net/~netstack More help : https://help.launchpad.net/ListHelp
