*** irenab has joined #openstack-gluon | 06:46 | |
*** irenab has quit IRC | 07:02 | |
*** irenab has joined #openstack-gluon | 07:04 | |
*** irenab has quit IRC | 08:27 | |
*** irenab has joined #openstack-gluon | 09:17 | |
*** xsp has quit IRC | 09:42 | |
*** irenab has quit IRC | 14:14 | |
*** trevormc has joined #openstack-gluon | 14:48 | |
*** trevormc_ has joined #openstack-gluon | 14:48 | |
*** trevormc_ has quit IRC | 14:48 | |
*** trevormc_ has joined #openstack-gluon | 19:38 | |
trevormc_ | tomhambleton, kamal___: were getting started on the documentation and it looks like the documentation you asked us to do is already done in the port-service-binding-model.rst file | 19:42 |
---|---|---|
trevormc_ | this is confusing me https://review.openstack.org/#/c/392250/ | 19:45 |
trevormc_ | all we need to do is write documentation on how to write this https://github.com/openstack/gluon/blob/master/gluon/models/proton/net-l3vpn/port_model.yaml right? | 19:47 |
kamal___ | What we need is a user documentation of the YAML model. The blue print is more of a internal design document | 20:22 |
kamal___ | The user documentation is for network designers who would define the service and baseports | 20:23 |
kamal___ | In terms of the content, it is already there but it is matter of presentation | 20:23 |
trevormc | kamal___: Ok that makes sense, What's wrong with the current presentation? | 20:24 |
kamal___ | you mean the blue print? | 20:24 |
trevormc | yes | 20:24 |
*** trevormc_ has quit IRC | 20:25 | |
kamal___ | let me see if I can find some neutron documentation that can be used as a reference | 20:25 |
trevormc | that would be great. A side by side comparison would be very helpful. | 20:25 |
kamal___ | Check this page. It is more of an API documentation but oriented towards users than for internal purpose http://developer.openstack.org/api-ref/networking/v2/index.html | 20:29 |
trevormc | kamal___: ok that doesn't look bad. So we will create one index file that links to the blueprint content? I think I am missing the point on the presentation of the blueprint. I can apply the rst formatting if that's what you wanted? Like code blocks and using double back quotes for variable names and such. | 20:37 |
trevormc | so 1. create index file and 2. apply rst formatting where possible in blueprint content. | 20:38 |
kamal___ | also it should go into the gluon repo instead of being in a blueprint | 20:38 |
kamal___ | there is a docs folder, which we can use for this purpose | 20:38 |
trevormc | ok, in 392250 it is already in the docs folder. Typically specs are submitted to <project name>-specs repository | 20:39 |
trevormc | specs aka blueprint | 20:40 |
kamal___ | thats fine. Just make it more digestible for network designers. Blueprint has much more information about the philosophy of the design. You can cut that out and make it a strictly a user documentation on what exactly the user has to define to get going | 20:42 |
trevormc | great, i think we understand now. Thanks for explaining it kamal___ | 20:43 |
alraddarla_ | Sorry, apparently I was disconnected and didn't realize until Trevor told me. Thanks for the insight kamal___ | 20:44 |
kamal___ | np | 20:44 |
kamal___ | https://etherpad.opnfv.org/p/Install_Gluon_Plugin | 21:09 |
kamal___ | This has instructions for installing Gluon | 21:09 |
alraddarla_ | awesome thanks | 21:26 |
*** trevormc has quit IRC | 22:26 |
Generated by irclog2html.py 2.14.0 by Marius Gedminas - find it at mg.pov.lt!