[openstack-dev] [all][doc] migration update
We have recovered old tagged content from https://docs.openstack.org/developer/$project and moved them to https://docs.openstack.org/$project/$version. As part of this process, we also kept any builds from the tip of the mitaka, newton, and ocata branches using those names as $version. And finally, for the projects that have had no doc builds since we updated the output location of the documentation job, we moved their /developer/$project content over to /$project/latest. Big thanks to fungi for helping with the restoration! Doug __ OpenStack Development Mailing List (not for usage questions) Unsubscribe: openstack-dev-requ...@lists.openstack.org?subject:unsubscribe http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-dev
Re: [openstack-dev] [all] Doc dependencies
On 2015-10-02 10:20:49 -0500 (-0500), Kevin L. Mitchell wrote: [...] > it feels wrong for us to install dependencies not directly related > to testing, even if we also test the doc generation. [...] It's a bit of a mischaracterization to suggest that there is some specific set of "dependencies [...] directly related to testing" in a more tightly-coupled fashion than those required for testing the included documentation builds. If you wanted to start splitting these up, really just about every environment defined in tox could conceivably have its own specific set of requirements which omits those only used by the other environments (for example, why install modules that won't be imported during a pep8 run? why install static analysis tools when running unit tests?). At least for now we can sort of draw a fuzzy line around things not commonly used at run-time and call them testing-related. -- Jeremy Stanley __ OpenStack Development Mailing List (not for usage questions) Unsubscribe: openstack-dev-requ...@lists.openstack.org?subject:unsubscribe http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-dev
Re: [openstack-dev] [all] Doc dependencies
On Fri, 2015-10-02 at 11:00 -0400, Sean Dague wrote: > On 10/02/2015 10:53 AM, Kevin L. Mitchell wrote: > > The Pillow-breaking-gate issue was related to having doc dependencies > > listed in the test-requirements.txt; however, those dependencies are not > > needed for testing, except for doc testing and generation. What do > > people think about creating a new "doc-requirements.txt" file that would > > contain only the doc dependencies? The appropriate doc environments in > > tox.ini would then need to be extended to pull in that file, and of > > course the global requirements tooling would have to be enhanced to > > recognize the new file as well. > > It would still have broken the gate, we test if docs build on every commit. Yes—this is why I characterized it as "related"—but the test failure would have at least been isolated to the docs test. That would have allowed reviews to get useful test results, instead of having a dependency installation issue. It's ultimately just a thought; it feels wrong for us to install dependencies not directly related to testing, even if we also test the doc generation. > I think the bigger question is if we believe that a c compiler should be > required to build docs on a python project. Which seems really weird to > me. And a substantially higher barrier to entry than I think we want for > docs contributions. Well, Pillow isn't the only transitive dependency that's going to require a C compiler; there are many other dependencies we have that are actually extensions. > There was only 1 use of this in all of Nova, and I think we're better > off removing it and coming up with other ways of addressing it. Perhaps, but having diagrams in the documentation is still going to be incredibly useful, and Nova isn't the only component we have to consider (which is why I removed the [nova] tag from the subject line). That said, I have no objection if we find or create a tool that generates images without depending on Pillow, but…*shrug* -- Kevin L. Mitchell Rackspace __ OpenStack Development Mailing List (not for usage questions) Unsubscribe: openstack-dev-requ...@lists.openstack.org?subject:unsubscribe http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-dev
Re: [openstack-dev] [all] Doc dependencies
On 10/02/2015 10:53 AM, Kevin L. Mitchell wrote: > The Pillow-breaking-gate issue was related to having doc dependencies > listed in the test-requirements.txt; however, those dependencies are not > needed for testing, except for doc testing and generation. What do > people think about creating a new "doc-requirements.txt" file that would > contain only the doc dependencies? The appropriate doc environments in > tox.ini would then need to be extended to pull in that file, and of > course the global requirements tooling would have to be enhanced to > recognize the new file as well. It would still have broken the gate, we test if docs build on every commit. I think the bigger question is if we believe that a c compiler should be required to build docs on a python project. Which seems really weird to me. And a substantially higher barrier to entry than I think we want for docs contributions. There was only 1 use of this in all of Nova, and I think we're better off removing it and coming up with other ways of addressing it. -Sean -- Sean Dague http://dague.net __ OpenStack Development Mailing List (not for usage questions) Unsubscribe: openstack-dev-requ...@lists.openstack.org?subject:unsubscribe http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-dev
[openstack-dev] [all] Doc dependencies (was: Re: [infra][nova][all] Pillow breaking gate?)
The Pillow-breaking-gate issue was related to having doc dependencies listed in the test-requirements.txt; however, those dependencies are not needed for testing, except for doc testing and generation. What do people think about creating a new "doc-requirements.txt" file that would contain only the doc dependencies? The appropriate doc environments in tox.ini would then need to be extended to pull in that file, and of course the global requirements tooling would have to be enhanced to recognize the new file as well. -- Kevin L. Mitchell Rackspace __ OpenStack Development Mailing List (not for usage questions) Unsubscribe: openstack-dev-requ...@lists.openstack.org?subject:unsubscribe http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-dev
Re: [openstack-dev] [all][doc] project testing interface
Angelo Matarazzo writes: > Hi all, > I have a question for you devs. > I don't understand the difference between this link > http://git.openstack.org/cgit/openstack/governance/tree/reference/project-testing-interface.rst > and > https://wiki.openstack.org/wiki/ProjectTestingInterface > > Some parts don't match (e.g. unittest running section). > If the git link is the right doc should we update the wiki page? > > I found the reference to the wiki page here: > https://lists.launchpad.net/openstack/msg08058.html The git repo is authoritative now, and the wiki is out of date. Feel free to update the wiki to point to the git repo. We're working on publishing the governance repo and so should have a nicer looking page and URL for that soon. Thanks! -Jim ___ OpenStack-dev mailing list OpenStack-dev@lists.openstack.org http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-dev
Re: [openstack-dev] [all][doc] project testing interface
On 10/24/2014 03:03 PM, Anne Gentle wrote: > The git link is the reference, and we're working on publishing those, > just have to get a URL/home sorted out. > > In the meantime, yes, you can update the wiki page. Why not delete the wiki altogether? I think stale content on the wiki is damaging us and if we're all agreeing that it's better to use rst files in git then let's get rid of old content on the wiki, put redirects or warnings on those pages. /stef ___ OpenStack-dev mailing list OpenStack-dev@lists.openstack.org http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-dev
Re: [openstack-dev] [all][doc]
On Oct 24, 2014, at 3:33 AM, Angelo Matarazzo wrote: > Hi all, > I have a question for you devs. > I don't understand the difference between this link > http://git.openstack.org/cgit/openstack/governance/tree/reference/ > project-testing-interface.rst > and > https://wiki.openstack.org/wiki/ProjectTestingInterface > > Some parts don't match (e.g. unittest running section). > If the git link is the right doc should we update the wiki page? > > I found the reference to the wiki page here: > https://lists.launchpad.net/openstack/msg08058.html > > Best regards, > Angelo We’re working on setting things up so the rst files in that git repository can be published as HTML. When we do that, we should update the wiki page to link to the HTML page. For now, the rst file should be considered the canonical reference, since it is the version managed by the TC. Doug ___ OpenStack-dev mailing list OpenStack-dev@lists.openstack.org http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-dev
Re: [openstack-dev] [all][doc] project testing interface
On Fri, Oct 24, 2014 at 2:40 AM, Angelo Matarazzo < angelo.matara...@dektech.com.au> wrote: > Hi all, > I have a question for you devs. > I don't understand the difference between this link > http://git.openstack.org/cgit/openstack/governance/tree/ > reference/project-testing-interface.rst > and > https://wiki.openstack.org/wiki/ProjectTestingInterface > > Some parts don't match (e.g. unittest running section). > If the git link is the right doc should we update the wiki page? > > The git link is the reference, and we're working on publishing those, just have to get a URL/home sorted out. In the meantime, yes, you can update the wiki page. Thanks, Anne > I found the reference to the wiki page here: > https://lists.launchpad.net/openstack/msg08058.html > > Best regards, > Angelo > > ___ > OpenStack-dev mailing list > OpenStack-dev@lists.openstack.org > http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-dev > ___ OpenStack-dev mailing list OpenStack-dev@lists.openstack.org http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-dev
[openstack-dev] [all][doc] project testing interface
Hi all, I have a question for you devs. I don't understand the difference between this link http://git.openstack.org/cgit/openstack/governance/tree/reference/project-testing-interface.rst and https://wiki.openstack.org/wiki/ProjectTestingInterface Some parts don't match (e.g. unittest running section). If the git link is the right doc should we update the wiki page? I found the reference to the wiki page here: https://lists.launchpad.net/openstack/msg08058.html Best regards, Angelo ___ OpenStack-dev mailing list OpenStack-dev@lists.openstack.org http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-dev
[openstack-dev] [all][doc]
Hi all, I have a question for you devs. I don't understand the difference between this link http://git.openstack.org/cgit/openstack/governance/tree/reference/ project-testing-interface.rst and https://wiki.openstack.org/wiki/ProjectTestingInterface Some parts don't match (e.g. unittest running section). If the git link is the right doc should we update the wiki page? I found the reference to the wiki page here: https://lists.launchpad.net/openstack/msg08058.html Best regards, Angelo ___ OpenStack-dev mailing list OpenStack-dev@lists.openstack.org http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-dev
