From f815df6ab594324bda2ce944c20ffeb3cdc14458 Mon Sep 17 00:00:00 2001 From: Alan Meadows Date: Fri, 22 May 2015 11:49:35 -0700 Subject: [PATCH] Create MAINTAINERS.md * Create new MAINTAINERS.md file with a pointer to central maintainers page * Update README.md to point users at the attributes files directly * Cleanup CONTRIBUTING.md links Change-Id: I626074a06dc4cc8c4641c68e55f4c3ffe50658e3 --- CONTRIBUTING.md | 5 +++-- MAINTAINERS.md | 3 +++ README.md | 12 ++++++++++-- 3 files changed, 16 insertions(+), 4 deletions(-) create mode 100644 MAINTAINERS.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index ccba39f..62f808f 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -30,7 +30,8 @@ Bugs should be filed on Launchpad, not GitHub: Contacts -------- -Mailing list: groups.google.com/group/opscode-chef-openstack +Mailing List URL: http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-dev +Mailing List Topic: [chef] IRC: #openstack-chef is our channel on irc.freenode.net -Wiki: https://wiki.openstack.org/wiki/Chef/GettingStarted and https://docs.getchef.com/openstack.html +Wiki: https://wiki.openstack.org/wiki/Chef Twitter: @chefopenstack diff --git a/MAINTAINERS.md b/MAINTAINERS.md new file mode 100644 index 0000000..87266d4 --- /dev/null +++ b/MAINTAINERS.md @@ -0,0 +1,3 @@ +The chef core reviewer membership and contact information is centrally maintained [here](http://bit.ly/openstack-chef-maintainers). + +Please don't hesitate to reach out of you have questions or concerns related to this project. We are here to help. diff --git a/README.md b/README.md index 2b7eecb..b4328cc 100644 --- a/README.md +++ b/README.md @@ -10,11 +10,19 @@ https://wiki.openstack.org/wiki/Ironic Requirements ------------ -Chef 11 or higher required (for Chef environment use). +Chef 12 or higher required (for Chef environment use). Attributes ---------- -TODO: List your cookbook attributes here. + +Please see the extensive inline documentation in `attributes/*.rb` for descriptions +of all the settable attributes for this cookbook. + +There are also many common attributes shared across the cookbooks that are found in +the cookbook-openstack-common cookbook attribute files. + +Note that all attributes are in the `default["openstack"]` "namespace" + Usage -----