[openstack-dev] [magnum] How to document 'labels'
Fox, Kevin M
Kevin.Fox at pnnl.gov
Wed May 11 23:51:09 UTC 2016
Heat added a panel in horizon to describe all the resources they have. Not sure you would want to do it the same way, but there is at least one other project that ran into this issue and took a stab at solving it. Might be worth a look.
From: Hongbin Lu [hongbin.lu at huawei.com]
Sent: Wednesday, May 11, 2016 12:52 PM
To: OpenStack Development Mailing List (not for usage questions)
Cc: Qun XK Wang
Subject: [openstack-dev] [magnum] How to document 'labels'
This is a continued discussion from the last team meeting. For recap, ‘labels’ is a property in baymodel and is used by users to input additional key-pair pairs to configure the bay. In the last team meeting, we discussed what is the best way to document ‘labels’. In general, I heard three options:
1. Place the documentation in Magnum CLI as help text (as Wangqun proposed ).
2. Place the documentation in Magnum server and expose them via the REST API. Then, have the CLI to load help text of individual properties from Magnum server.
3. Place the documentation in a documentation server (like developer.openstack.org/…), and add the doc link to the CLI help text.
For option #1, I think an advantage is that it is close to end-users, thus providing a better user experience. In contrast, Tom Cammann pointed out a disadvantage that the CLI help text might be easier to become out of date. For option #2, it should work but incurs a lot of extra work. For option #3, the disadvantage is the user experience (since user need to click the link to see the documents) but it makes us easier to maintain. I am thinking if it is possible to have a combination of #1 and #3. Thoughts?
-------------- next part --------------
An HTML attachment was scrubbed...
More information about the OpenStack-dev