Hi Aric, Thanks for the explanation.
Just one comment: In general, I would say that if a project intends to contribute any kind of documentation to Danube despite not officially participating in the release, this project shall nevertheless create a stable/danube branch. That's how we did it for NetReady for the Colorado release. To my understanding, git submodules don't refer to branches anyway, but to exact commits (which need to be bumped once in a while). But now I suppose you don’t indent to use this particular feature of git submodules, but right away clone a given branch for all submodules. So, the submodules are just used to keep track of all repos, not of their particular version? Just being curious. Best regards Georg > -----Original Message----- > From: Aric Gardner [mailto:[email protected]] > Sent: Wednesday, February 22, 2017 8:35 PM > To: Georg Kunz <[email protected]> > Cc: Sofia Wallin <[email protected]>; TECH-DISCUSS OPNFV (opnfv- > [email protected]) <[email protected]>; opnfv- > [email protected] > Subject: Re: [opnfv-tech-discuss] [opnfv-project-leads] [opnfvdocs] Update > - Migration to readthedocs > > Hi Georg, > > The job will always recursively clone the submodules under opnfvfocs, so > each submodule will be on the tip of (branch) and if relevant the current > $GERRIT_PATCHSET. > > But that does have me wondering what kind of breakage we will face if > $project is not cutting (eg not participating) in Danube. > We still need to included non Danube participating projects' > documentation, in the Danube builds. > > Nothing is in place yet to deal with inconsistencies in branching between > projects. > > Regards, > Aric > > On Wed, Feb 22, 2017 at 12:09 PM, Georg Kunz <[email protected]> > wrote: > > Hi Sofia, > > > > > > > > One question regarding the submodules: how do you manage the > > versioning of the submodules? Do we need to manually bump the version > > of the respective project submodule after submitting new documentation > > to our project repo or will your Jenkins job automatically bump the version? > > > > > > > > Thanks, > > > > Georg > > > > > > > > From: [email protected] > > [mailto:[email protected]] On Behalf Of > > Sofia Wallin > > Sent: Wednesday, February 22, 2017 11:26 AM > > To: TECH-DISCUSS OPNFV ([email protected]) > > <[email protected]>; > > [email protected] > > Subject: [opnfv-project-leads] [opnfvdocs] [opnfv-tech-discuss] Update > > - Migration to readthedocs > > > > > > > > Hello, > > > > As many of you already know, as part of the Danube release we are > > migrating all our documentation to readthedocs, an online > > documentation service. There are a few changes with respect to > > documentation that everyone should be aware of: > > > > Distinct release, development and testing documentation As part of the > > D release, the docs projects is working towards organizing the > > documentation under three distinct banners: release, development and > > testing, as also seen on docs.opnfv.org [1] We have put together a > > documentation guide [2] which will help project teams understand the > > changes expected in each project repo. > > > > NOTE: Discussions regarding structure of the page and naming was > > brought up yesterday and are ongoing. > > > > Simplified documentation toolchain > > The move to readthedocs has greatly simplified our documentation > toolchain. > > The docs project has incorporated each project as a submodule in its repo. > > Whenever content is merged in <project>/docs/, the documentation > > toolchain shall automatically trigger building of the new > > documentation on readthedocs (allow around 15 minutes for the > > documentation to show after merging). The new doc jobs are docs-verify- > rtd-{stream} & docs-merge-rtd-{stream}. > > > > Detailed instructions on how to include documentation, validate markup > > and test build (locally) have been mentioned in the 'Include > > Documentation' [3] > > > > We shall gradually be phasing out the artifacts.opnfv.org as part of > > the migration to readthedocs. Project teams are requested to adapt to > > the new tool chain. > > > > Please let us know if you have questions. > > > > Regards, > > > > OPNFVDOCS Team > > > > > > [1] http://docs.opnfv.org/en/latest/ > > > > [2] > > http://docs.opnfv.org/en/latest/how-to-use-docs/documentation- > guide.ht > > ml > > > > [3] > > http://docs.opnfv.org/en/latest/how-to-use-docs/include- > documentation. > > html > > > > > > > > > > _______________________________________________ > > opnfv-tech-discuss mailing list > > [email protected] > > https://lists.opnfv.org/mailman/listinfo/opnfv-tech-discuss > > _______________________________________________ opnfv-tech-discuss mailing list [email protected] https://lists.opnfv.org/mailman/listinfo/opnfv-tech-discuss
