Comment 2 for bug 1521443

Revision history for this message
Ruby Loo (rloo) wrote :

I added a comment to the patch 252371, and I'll copy it here, because I'm not sure that we want to do this.

---------

Hi Shuquan, I'm not sure this is the 'right' place to mention it but it is all related so...

I just discovered that the openstack admin guide has a baremetal/troubleshooting section[1] which includes almost all of what we have in our troubleshooting page[2]. Since you seem to be the author of both sets of changes and you are making this change, I'd like to know what/if you have thoughts on how the documentation ought to be structured.

I don't think it makes sense to document things in more than one place, because it means having to update both of them (if anyone knows that they are in two places). As it is, the two versions I mentioned are not the same. I'm wondering why they aren't (should they be?), and I'm also wondering whether it makes sense to make the changes in this patch. Shouldn't this information just go into the troubleshooting section of the admin guide?

Thank you so much for working on the documentation, but I think we ought to step back a bit and figure out where we're going (or perhaps you know and if so I'd like you to communicate it to us, or if you did I must have missed it.)

[1] http://docs.openstack.org/admin-guide-cloud/baremetal.html
[2] http://docs.openstack.org/developer/ironic/deploy/troubleshooting.html#nova-returns-no-valid-host-was-found-error