<div dir="ltr">.To kind of sum things up: issues with pulp-smash itself will still be filled in the pulp-smash Github repo. Also, the documentation for pulp-smash will continue to reside on readthedocs (RTD). <div><br></div><div>For Pulp 2, issues with the tests will be filed at the Pulp-2-tests repo and the docs for tests will reside on RTD.<div><br></div><div>For Pulp 3, the actual pulp-smash tests for both core and plugins, the issues will be filed in redmine with the new “Functional Test” tag. Also, documentation for these tests will live alongside the core/plugin docs.</div><div><br></div><div>It seems like there’s consensus around this plan. With that, I’d like to give it until Wednesday (August 29, 2018) and then we can proceed.</div><div><br></div><div>Thanks.<br clear="all"><div><div dir="ltr" class="m_2009307312035881695gmail_signature" data-smartmail="gmail_signature"><div dir="ltr"><div><div dir="ltr"><div><div dir="ltr"><div><br></div><div>David<br></div></div></div></div></div></div></div></div><br></div></div></div><br><div class="gmail_quote"><div dir="ltr">On Wed, Aug 22, 2018 at 9:56 AM Brian Bouterse <<a href="mailto:bbouters@redhat.com" target="_blank">bbouters@redhat.com</a>> wrote:<br></div><blockquote class="gmail_quote" style="margin:0 0 0 .8ex;border-left:1px #ccc solid;padding-left:1ex"><div dir="ltr"><div>Sounds good Kersom. I think we're on the same page, but want to write a description to help be sure. Here is what we can offer in terms of the docs:</div><div><br></div><div>Any docstring that is within the same repo as the sphinx project can be included. This is true for a plugin repo and core. I'll give an example with core because that is the only one with all the pieces right now that I need to show. For example with pulp/pulp [0] the sphinx project is here [1] and any docstring like this one [2] can be easily included in the docs with syntax like this [3] which product output like that [4].<br></div><div><br></div><div>What we aren't able to do is include docstrings from other repos. For instance we can't include docstrings from <a href="https://github.com/PulpQE/pulp-smash/" target="_blank">https://github.com/PulpQE/pulp-smash/</a> on a page in the core docs or any plugin docs because the docstrings aren't in the same repo as the sphinx project they would be included in.</div><div><br></div><div>Hopefully this is how everyone understands it.<br></div><div><br></div><div>[0]: <a href="https://github.com/pulp/pulp/" target="_blank">https://github.com/pulp/pulp/</a></div><div>[1]: <a href="https://github.com/pulp/pulp/tree/master/docs" target="_blank">https://github.com/pulp/pulp/tree/master/docs</a></div><div>[2]: <a href="https://github.com/pulp/pulp/blob/master/plugin/pulpcore/plugin/stages/artifact_stages.py#L13-L33" target="_blank">https://github.com/pulp/pulp/blob/master/plugin/pulpcore/plugin/stages/artifact_stages.py#L13-L33</a></div><div>[3]: <a href="https://github.com/pulp/pulp/blob/master/docs/plugins/plugin-api/stages.rst#artifact-related-stages" target="_blank">https://github.com/pulp/pulp/blob/master/docs/plugins/plugin-api/stages.rst#artifact-related-stages</a><br></div><div>[4]: <a href="https://docs.pulpproject.org/en/3.0/nightly/plugins/plugin-api/stages.html#pulpcore.plugin.stages.QueryExistingArtifacts" target="_blank">https://docs.pulpproject.org/en/3.0/nightly/plugins/plugin-api/stages.html#pulpcore.plugin.stages.QueryExistingArtifacts</a></div><div><br></div><div>All the best,</div><div>Brian<br></div><div><br></div><div><br></div></div><div class="gmail_extra"><br><div class="gmail_quote">On Mon, Aug 20, 2018 at 5:57 PM, Kersom <span dir="ltr"><<a href="mailto:kersom@redhat.com" target="_blank">kersom@redhat.com</a>></span> wrote:<br><blockquote class="gmail_quote" style="margin:0 0 0 .8ex;border-left:1px #ccc solid;padding-left:1ex"><div dir="ltr"><div>I am ok with your suggestions Brian. <br></div><div><br></div><div> I like the idea to the documents for the test related to a certain plugin live at the same website as the plugin itself. I am not sure how much adjustments will be necessary to the doctrings for the tests to be added to the current plugin docs. Maybe just add another section related to the tests.</div><span><div><br></div><div>> To demo an idea, I just added a 'Functional Test' tag which should be available on all Redmine projects. If we want to rename it, or delete it, we can. How would that work?<br></div><div><br></div></span><div>I thins this a good start. We can try to adjust if necessary.</div><div><br></div><div><br></div><div><br></div></div><div class="m_2009307312035881695m_5512446309738423204HOEnZb"><div class="m_2009307312035881695m_5512446309738423204h5"><div class="gmail_extra"><br><div class="gmail_quote">On Mon, Aug 13, 2018 at 4:24 PM, Brian Bouterse <span dir="ltr"><<a href="mailto:bbouters@redhat.com" target="_blank">bbouters@redhat.com</a>></span> wrote:<br><blockquote class="gmail_quote" style="margin:0 0 0 .8ex;border-left:1px #ccc solid;padding-left:1ex"><div dir="ltr">Thanks for the reply Kersom. I responded inline.<br><div class="gmail_extra"><br><div class="gmail_quote"><span>On Mon, Aug 13, 2018 at 3:49 PM, Kersom <span dir="ltr"><<a href="mailto:kersom@redhat.com" target="_blank">kersom@redhat.com</a>></span> wrote:<br><blockquote class="gmail_quote" style="margin:0px 0px 0px 0.8ex;border-left:1px solid rgb(204,204,204);padding-left:1ex"><div dir="ltr"><div>Thank you for this thread.</div><div><br></div><div>Currently there are dedicated documents for Pulp-Smash on readthedocs. [0]</div><div>Issues related to Pulp-Smash itself should be filed here [1]<br></div></div></blockquote></span><div>+1 <br></div><span><blockquote class="gmail_quote" style="margin:0px 0px 0px 0.8ex;border-left:1px solid rgb(204,204,204);padding-left:1ex"><div dir="ltr"><div></div><div><br></div><div>Documentation for Pulp 2 tests were created on readthedocs [2] after these tests were moved from Pulp-Smash.</div><div>Issues related to Pulp 2 should be filed here [3]<br></div></div></blockquote></span><div>+1 <br></div><span><blockquote class="gmail_quote" style="margin:0px 0px 0px 0.8ex;border-left:1px solid rgb(204,204,204);padding-left:1ex"><div dir="ltr"><div></div><div><br></div><div>Pulp 3 tests were migrated to Pulp repositories, but there are no documentation for them right now. In my opinion, documentation for tests, code standards for tests, and examples will drive more contributions. I am not sure what the best option is to generate and host these docs.<br></div></div></blockquote><div><br></div></span><div>For topics specific to a plugin, I agree it should go in the repo w/ the functional tests themselves. Some plugins host those docs via <a href="http://github.com" target="_blank">github.com</a> browseable readme's, (e.g. <a href="https://github.com/pulp/pulp_ansible/#pulp-ansible" target="_blank">https://github.com/pulp/pulp_ansible/#pulp-ansible</a>) or via a read the docs website (e.g. <a href="http://pulp-python.readthedocs.io/en/3.0-dev/" target="_blank">http://pulp-python.readthedocs.io/en/3.0-dev/</a>). The <a href="http://docs.pulpproject.org" target="_blank">docs.pulpproject.org</a> site can't host plugin docs for Pulp3, only core code.<br></div><span><blockquote class="gmail_quote" style="margin:0px 0px 0px 0.8ex;border-left:1px solid rgb(204,204,204);padding-left:1ex"><div dir="ltr"><div></div><div><br></div><div>I think we can use the plugin issue tracker to track tests related to a certain plugin. Perhaps a certain field, or anchor can be used to allow filters for issues that require tests. Maybe the same approach can be used for the pulp core as well.<br></div></div></blockquote><div> </div></span><div>To demo an idea, I just added a 'Functional Test' tag which should be available on all Redmine projects. If we want to rename it, or delete it, we can. How would that work?<br></div><div><div class="m_2009307312035881695m_5512446309738423204m_837496105778960807h5"><div> <br></div><blockquote class="gmail_quote" style="margin:0px 0px 0px 0.8ex;border-left:1px solid rgb(204,204,204);padding-left:1ex"><div dir="ltr"><div></div><div><br></div><div>[0] <a href="https://pulp-smash.readthedocs.io/en/latest/" target="_blank">https://pulp-smash.readthedocs.io/en/latest/</a></div><div>[1] <a href="https://github.com/PulpQE/pulp-smash" target="_blank">https://github.com/PulpQE/pulp-smash</a></div><div>[2] <a href="https://pulp-2-tests.readthedocs.io/en/latest/" target="_blank">https://pulp-2-tests.readthedocs.io/en/latest/</a><br></div><div>[3] <a href="https://github.com/PulpQE/Pulp-2-Tests" target="_blank">https://github.com/PulpQE/Pulp-2-Tests</a><br></div><div><br></div><br></div><div class="m_2009307312035881695m_5512446309738423204m_837496105778960807m_-2446215258785698880gmail-HOEnZb"><div class="m_2009307312035881695m_5512446309738423204m_837496105778960807m_-2446215258785698880gmail-h5"><div class="gmail_extra"><br><div class="gmail_quote">On Fri, Aug 10, 2018 at 10:16 AM, Brian Bouterse <span dir="ltr"><<a href="mailto:bbouters@redhat.com" target="_blank">bbouters@redhat.com</a>></span> wrote:<br><blockquote class="gmail_quote" style="margin:0px 0px 0px 0.8ex;border-left:1px solid rgb(204,204,204);padding-left:1ex"><div dir="ltr"><br><div class="gmail_extra"><br><div class="gmail_quote"><span>On Thu, Aug 9, 2018 at 5:42 PM, Daniel Alley <span dir="ltr"><<a href="mailto:dalley@redhat.com" target="_blank">dalley@redhat.com</a>></span> wrote:<br><blockquote class="gmail_quote" style="margin:0px 0px 0px 0.8ex;border-left:1px solid rgb(204,204,204);padding-left:1ex"><div dir="ltr"><span class="m_2009307312035881695m_5512446309738423204m_837496105778960807m_-2446215258785698880gmail-m_4102437373680885084m_-3835207302489268325gmail-"><blockquote class="gmail_quote" style="margin:0px 0px 0px 0.8ex;border-left:1px solid rgb(204,204,204);padding-left:1ex">I think this is fine where it is. pulp2 is going into maintenance mode at some point here soon.</blockquote><div><br></div></span><div>That makes sense for the Pulp 2 smash test docs, but it's still a problem if we want to have smash test docs for Pulp 3 (which, we do)<br></div></div></blockquote></span><div>That's true, we do need it to live somewhere.</div><div><br></div><div>The main thing I want to avoid is trying to include content from one repo, i.e. PulpQE/pulp-smash to be published through the docs of the sphinx project in pulp/pulp. In terms of what pulp-smash offers and how to use it, I think that should be its own site, separate from Pulp's docs. Additionally, I could imagine a section in our docs either recommending pulp-smash and linking to the pulp-smash docs, and maybe expanding on its examples some. Is this kind of what you imagined? How is it similar/different?<br></div><span><div><br></div><blockquote class="gmail_quote" style="margin:0px 0px 0px 0.8ex;border-left:1px solid rgb(204,204,204);padding-left:1ex"><div dir="ltr"><div></div></div><div class="m_2009307312035881695m_5512446309738423204m_837496105778960807m_-2446215258785698880gmail-m_4102437373680885084m_-3835207302489268325gmail-HOEnZb"><div class="m_2009307312035881695m_5512446309738423204m_837496105778960807m_-2446215258785698880gmail-m_4102437373680885084m_-3835207302489268325gmail-h5"><div class="gmail_extra"><br><div class="gmail_quote">On Thu, Aug 9, 2018 at 5:12 PM, Brian Bouterse <span dir="ltr"><<a href="mailto:bbouters@redhat.com" target="_blank">bbouters@redhat.com</a>></span> wrote:<br><blockquote class="gmail_quote" style="margin:0px 0px 0px 0.8ex;border-left:1px solid rgb(204,204,204);padding-left:1ex"><div dir="ltr">Thanks for bringing this up. I put some responses inline.<br><div><div class="gmail_extra"><br><div class="gmail_quote"><span>On Thu, Aug 9, 2018 at 4:22 PM, David Davis <span dir="ltr"><<a href="mailto:daviddavis@redhat.com" target="_blank">daviddavis@redhat.com</a>></span> wrote:<br><blockquote class="gmail_quote" style="margin:0px 0px 0px 0.8ex;border-left:1px solid rgb(204,204,204);padding-left:1ex"><div dir="ltr">One of the things that may not make sense anymore is how we document and track issues for pulp-smash tests given that these tests no longer reside in the pulp-smash repo. Currently, all the test-related issues are tracked here[0]. <div><br></div><div>With the tests no longer in the pulp-smash repo, I wonder if it makes sense to maybe move them somewhere else like into redmine for Pulp 3 (or the pulp-2-tests[1] repo for Pulp 2).</div></div></blockquote></span><div>+1 to moving issues about the testing of a plugin to that plugin's tracker</div><span><div> <br></div><blockquote class="gmail_quote" style="margin:0px 0px 0px 0.8ex;border-left:1px solid rgb(204,204,204);padding-left:1ex"><div dir="ltr"><div><div><br></div><div>The other question is about documentation. Currently the pulp-smash test documentation is hosted on RTD (e.g. <a href="https://pulp-2-tests.readthedocs.io/en/latest/" target="_blank">https://pulp-2-tests.readthedocs.io/en/latest/</a>). Should this documentation live alongside the core/plugin docs?</div></div></div></blockquote></span><div>I think this is fine where it is. pulp2 is going into maintenance mode at some point here soon.<br></div><div><br></div><blockquote class="gmail_quote" style="margin:0px 0px 0px 0.8ex;border-left:1px solid rgb(204,204,204);padding-left:1ex"><span><div dir="ltr"><div><div><br></div><div>QE would like to hear feedback as to how to proceed by August 20, 2018 so please respond by then.</div><div><br></div><div>Thanks.<br><div><br></div><div>[0] <a href="https://github.com/pulpqe/pulp-smash/issues" target="_blank">https://github.com/pulpqe/pulp-smash/issues</a></div><div>[1] <a href="https://github.com/PulpQE/Pulp-2-Tests" target="_blank">https://github.com/PulpQE/Pulp-2-Tests</a><span class="m_2009307312035881695m_5512446309738423204m_837496105778960807m_-2446215258785698880gmail-m_4102437373680885084m_-3835207302489268325gmail-m_852235873114840400m_-2220728569180709353HOEnZb"><font color="#888888"><br clear="all"><div><div dir="ltr" class="m_2009307312035881695m_5512446309738423204m_837496105778960807m_-2446215258785698880gmail-m_4102437373680885084m_-3835207302489268325gmail-m_852235873114840400m_-2220728569180709353m_6969283381526805951gmail_signature"><div dir="ltr"><div><div dir="ltr"><div><div dir="ltr"><div><br></div><div>David<br></div></div></div></div></div></div></div></div></font></span></div></div></div></div> <br></span>_______________________________________________<br> Pulp-dev mailing list<br> <a href="mailto:Pulp-dev@redhat.com" target="_blank">Pulp-dev@redhat.com</a><br> <a href="https://www.redhat.com/mailman/listinfo/pulp-dev" rel="noreferrer" target="_blank">https://www.redhat.com/mailman/listinfo/pulp-dev</a><br> <br></blockquote></div><br></div></div></div> <br>_______________________________________________<br> Pulp-dev mailing list<br> <a href="mailto:Pulp-dev@redhat.com" target="_blank">Pulp-dev@redhat.com</a><br> <a href="https://www.redhat.com/mailman/listinfo/pulp-dev" rel="noreferrer" target="_blank">https://www.redhat.com/mailman/listinfo/pulp-dev</a><br> <br></blockquote></div><br></div> </div></div></blockquote></span></div><br></div></div> <br>_______________________________________________<br> Pulp-dev mailing list<br> <a href="mailto:Pulp-dev@redhat.com" target="_blank">Pulp-dev@redhat.com</a><br> <a href="https://www.redhat.com/mailman/listinfo/pulp-dev" rel="noreferrer" target="_blank">https://www.redhat.com/mailman/listinfo/pulp-dev</a><br> <br></blockquote></div><br></div> </div></div></blockquote></div></div></div><br></div></div> </blockquote></div><br></div> </div></div></blockquote></div><br></div> _______________________________________________<br> Pulp-dev mailing list<br> <a href="mailto:Pulp-dev@redhat.com" target="_blank">Pulp-dev@redhat.com</a><br> <a href="https://www.redhat.com/mailman/listinfo/pulp-dev" rel="noreferrer" target="_blank">https://www.redhat.com/mailman/listinfo/pulp-dev</a><br> </blockquote></div>