I would like to bring your attention on one discussion happening in the functest DOC gerrit review and that concerns every project that participates to euphrates. The question is should each project doc mention exactly which version of artifact to use (in case of functest it will be the exact dockerhub tag to pull)
Firstly, the project documentation as currently packaged is clearly related to an OPNFV release because it is part of an umbrella doc which is clearly labeled for a given release, so it is not necessary to mention to which OPNFV release each project doc is associated. Text like “this is the project documentation for the euphrates 5.0 release” should not be needed and should be removed. Secondly I don’t think every project doc should describe exactly which artifact tag to pull (eg. “pull opnfv/functest-core:opnfv-5.0.0”) for the following reasons: * There would be a lot of redundant explanation in every project doc (to keep in sync) * This would require project doc writers to be aware of the way artifacts are released and tagged (and possibly modified) * If there was a maintenance release the doc would have to be edited and kept in sync which is a lot of overhead * And last but not least, I believe it is in the interest of projects to keep a versioning of their code+doc that is independent of the OPNFV release (and this of course means you do not mention OPNFV release versions in your own doc) - one of the many reasons is that a project can ship to an external user a project specific version of its code (with a version tag 1.4.2 for example) and clearly you do not want the corresponding project documentation to say “euphrates 5.0” I think it would make more sense to have a global OPNFV release document that describes the release packaging: what are all the artifacts that make up a release, how they are versioned, where to find them: doc, ISO, dockerhub. Perhaps there is already such document? I was looking for such document when I started to look at OPNFV and had trouble finding the answer of what is it that OPNFV releases exactly. The doc is easy to find, but a list of git repos, docker hub repos, artifact repos is hardly sufficient. From what I can see (and I might be a bit simplistic), there are ISOs that correspond to OPNFV installers/deployers that install openstack + features and there are docker containers that mostly contain OPNFV tools for testing an installation of the same release. So it would kind of make sense to use the same version of testing tools to test a given version of openstack+features. Thanks Alec
_______________________________________________ opnfv-tech-discuss mailing list [email protected] https://lists.opnfv.org/mailman/listinfo/opnfv-tech-discuss
