Hi, I'd like to explore the idea of adopting the 'doc8' tool within the PyCQA organization. For anyone not familiar with the tool, 'doc8' markets itself as "an opinionated style checker for rst (with basic support for plain text) styles of documentation." It's currently maintained within the OpenStack community but there have been some valid concerns raised recently regarding the health of the 'doc8' tool [1]. While it is extensively used within OpenStack (and outside it too, fwiw), it's very much secondary to the core goal of OpenStack itself, which probably explains the lack of attention it's received over the last few years. While 'doc8' is not a checker for Python code itself, it is Python- based, is a "quality tool", and rST+docutils/Sphinx remains the documentation tool of choice for the Python community. For this reason, I think PyCQA might be a good fit as a parent organization. The other possible parent organizations I've been looking at are sphinx- doc/sphinx-contrib and docutils, but doc8 isn't actually Sphinx-based, which kind of rules out the former, while the docutils community are _still_ insisting on Sourceforge and Subversion, ruling them out :( Does anyone else think PyCQA might possibly make a good fit for 'doc8'? If so, I'll raise the idea formally within OpenStack and start on the paperwork to move things across. If not, I'd welcome other ideas for where this useful project could live. Stephen [1] http://lists.openstack.org/pipermail/openstack-discuss/2019-July/007669.html
On Sat, Jul 13, 2019 at 12:23 PM Stephen Finucane <stephen@that.guru> wrote:
Hi,
I'd like to explore the idea of adopting the 'doc8' tool within the PyCQA organization. For anyone not familiar with the tool, 'doc8' markets itself as "an opinionated style checker for rst (with basic support for plain text) styles of documentation." It's currently maintained within the OpenStack community but there have been some valid concerns raised recently regarding the health of the 'doc8' tool [1]. While it is extensively used within OpenStack (and outside it too, fwiw), it's very much secondary to the core goal of OpenStack itself, which probably explains the lack of attention it's received over the last few years.
While 'doc8' is not a checker for Python code itself, it is Python- based, is a "quality tool", and rST+docutils/Sphinx remains the documentation tool of choice for the Python community. For this reason, I think PyCQA might be a good fit as a parent organization. The other possible parent organizations I've been looking at are sphinx- doc/sphinx-contrib and docutils, but doc8 isn't actually Sphinx-based, which kind of rules out the former, while the docutils community are _still_ insisting on Sourceforge and Subversion, ruling them out :(
Does anyone else think PyCQA might possibly make a good fit for 'doc8'? If so, I'll raise the idea formally within OpenStack and start on the paperwork to move things across. If not, I'd welcome other ideas for where this useful project could live.
Stephen
[1] http://lists.openstack.org/pipermail/openstack-discuss/2019-July/007669.html
I thiink it's definitely a fit given its focus. I don't know that there's anyone in the PyCQA, however, who has the cycles to maintain it. Would you and Sorin be willing to maintain it inside the PyCQA? I'd be happy to set things up so that you both could add more maintainers easily. Cheers, Ian
On Sat, 2019-07-13 at 12:26 -0500, Ian Stapleton Cordasco wrote:
On Sat, Jul 13, 2019 at 12:23 PM Stephen Finucane <stephen@that.guru> wrote:
Hi,
I'd like to explore the idea of adopting the 'doc8' tool within the PyCQA organization. For anyone not familiar with the tool, 'doc8' markets itself as "an opinionated style checker for rst (with basic support for plain text) styles of documentation." It's currently maintained within the OpenStack community but there have been some valid concerns raised recently regarding the health of the 'doc8' tool [1]. While it is extensively used within OpenStack (and outside it too, fwiw), it's very much secondary to the core goal of OpenStack itself, which probably explains the lack of attention it's received over the last few years.
While 'doc8' is not a checker for Python code itself, it is Python- based, is a "quality tool", and rST+docutils/Sphinx remains the documentation tool of choice for the Python community. For this reason, I think PyCQA might be a good fit as a parent organization. The other possible parent organizations I've been looking at are sphinx- doc/sphinx-contrib and docutils, but doc8 isn't actually Sphinx-based, which kind of rules out the former, while the docutils community are _still_ insisting on Sourceforge and Subversion, ruling them out :(
Does anyone else think PyCQA might possibly make a good fit for 'doc8'? If so, I'll raise the idea formally within OpenStack and start on the paperwork to move things across. If not, I'd welcome other ideas for where this useful project could live.
Stephen
[1] http://lists.openstack.org/pipermail/openstack-discuss/2019-July/007669.html
I thiink it's definitely a fit given its focus. I don't know that there's anyone in the PyCQA, however, who has the cycles to maintain it. Would you and Sorin be willing to maintain it inside the PyCQA? I'd be happy to set things up so that you both could add more maintainers easily.
Yeah, that would be the expectation, though I would hope that some other interested parties might eventually discover the project and pitch in, of course (wishful thinking, perhaps :)). What are the next steps? Stephen
Cheers, Ian
I'm not sure. Bandit, however, completed the transition a few years ago. I suspect there are clues in Gerrit and on the mailing list archives here and there. Once y'all have a GitHub repository you'd like to move over. You can either add me to it so I can move it into the org or I can make the teams, make y'all moderators and I _think_ that will give you the ability to move it yourselves. On Tue, Jul 16, 2019 at 10:44 AM Stephen Finucane <stephen@that.guru> wrote:
On Sat, 2019-07-13 at 12:26 -0500, Ian Stapleton Cordasco wrote:
On Sat, Jul 13, 2019 at 12:23 PM Stephen Finucane <stephen@that.guru> wrote:
Hi,
I'd like to explore the idea of adopting the 'doc8' tool within the PyCQA organization. For anyone not familiar with the tool, 'doc8' markets itself as "an opinionated style checker for rst (with basic support for plain text) styles of documentation." It's currently maintained within the OpenStack community but there have been some valid concerns raised recently regarding the health of the 'doc8' tool [1]. While it is extensively used within OpenStack (and outside it too, fwiw), it's very much secondary to the core goal of OpenStack itself, which probably explains the lack of attention it's received over the last few years.
While 'doc8' is not a checker for Python code itself, it is Python- based, is a "quality tool", and rST+docutils/Sphinx remains the documentation tool of choice for the Python community. For this reason, I think PyCQA might be a good fit as a parent organization. The other possible parent organizations I've been looking at are sphinx- doc/sphinx-contrib and docutils, but doc8 isn't actually Sphinx-based, which kind of rules out the former, while the docutils community are _still_ insisting on Sourceforge and Subversion, ruling them out :(
Does anyone else think PyCQA might possibly make a good fit for 'doc8'? If so, I'll raise the idea formally within OpenStack and start on the paperwork to move things across. If not, I'd welcome other ideas for where this useful project could live.
Stephen
[1] http://lists.openstack.org/pipermail/openstack-discuss/2019-July/007669.html
I thiink it's definitely a fit given its focus. I don't know that there's anyone in the PyCQA, however, who has the cycles to maintain it. Would you and Sorin be willing to maintain it inside the PyCQA? I'd be happy to set things up so that you both could add more maintainers easily.
Yeah, that would be the expectation, though I would hope that some other interested parties might eventually discover the project and pitch in, of course (wishful thinking, perhaps :)).
What are the next steps?
Stephen
Cheers, Ian
On Thu, 2019-07-18 at 07:36 -0500, Ian Stapleton Cordasco wrote:
I'm not sure. Bandit, however, completed the transition a few years ago. I suspect there are clues in Gerrit and on the mailing list archives here and there. Once y'all have a GitHub repository you'd like to move over. You can either add me to it so I can move it into the org or I can make the teams, make y'all moderators and I _think_ that will give you the ability to move it yourselves.
Sure, I'll get a move on with this now, starting with a mail to openstack-discuss (just sent) and a patch based on [1]. Instead of moving a repo across though, perhaps you could just create an empty 'pycqa/doc8' repo that we can populate, adding us an admins in the process? This means we don't have to work through moving things from the OpenStack organization on GitHub or having the "forked from" metadata on the repo. If there's an empty repo, I can just push everything to that. Stephen [1] https://review.opendev.org/#/c/564453/
On Tue, Jul 16, 2019 at 10:44 AM Stephen Finucane <stephen@that.guru> wrote:
On Sat, 2019-07-13 at 12:26 -0500, Ian Stapleton Cordasco wrote:
On Sat, Jul 13, 2019 at 12:23 PM Stephen Finucane < stephen@that.guru> wrote:
Hi,
I'd like to explore the idea of adopting the 'doc8' tool within the PyCQA organization. For anyone not familiar with the tool, 'doc8' markets itself as "an opinionated style checker for rst (with basic support for plain text) styles of documentation." It's currently maintained within the OpenStack community but there have been some valid concerns raised recently regarding the health of the 'doc8' tool [1]. While it is extensively used within OpenStack (and outside it too, fwiw), it's very much secondary to the core goal of OpenStack itself, which probably explains the lack of attention it's received over the last few years.
While 'doc8' is not a checker for Python code itself, it is Python- based, is a "quality tool", and rST+docutils/Sphinx remains the documentation tool of choice for the Python community. For this reason, I think PyCQA might be a good fit as a parent organization. The other possible parent organizations I've been looking at are sphinx- doc/sphinx-contrib and docutils, but doc8 isn't actually Sphinx-based, which kind of rules out the former, while the docutils community are _still_ insisting on Sourceforge and Subversion, ruling them out :(
Does anyone else think PyCQA might possibly make a good fit for 'doc8'? If so, I'll raise the idea formally within OpenStack and start on the paperwork to move things across. If not, I'd welcome other ideas for where this useful project could live.
Stephen
[1] http://lists.openstack.org/pipermail/openstack-discuss/2019-July/007669.html
I thiink it's definitely a fit given its focus. I don't know that there's anyone in the PyCQA, however, who has the cycles to maintain it. Would you and Sorin be willing to maintain it inside the PyCQA? I'd be happy to set things up so that you both could add more maintainers easily.
Yeah, that would be the expectation, though I would hope that some other interested parties might eventually discover the project and pitch in, of course (wishful thinking, perhaps :)).
What are the next steps?
Stephen
Cheers, Ian
On Thu, Jul 18, 2019 at 8:04 AM Stephen Finucane <stephen@that.guru> wrote:
On Thu, 2019-07-18 at 07:36 -0500, Ian Stapleton Cordasco wrote:
I'm not sure. Bandit, however, completed the transition a few years ago. I suspect there are clues in Gerrit and on the mailing list archives here and there. Once y'all have a GitHub repository you'd like to move over. You can either add me to it so I can move it into the org or I can make the teams, make y'all moderators and I _think_ that will give you the ability to move it yourselves.
Sure, I'll get a move on with this now, starting with a mail to openstack-discuss (just sent) and a patch based on [1]. Instead of moving a repo across though, perhaps you could just create an empty 'pycqa/doc8' repo that we can populate, adding us an admins in the process? This means we don't have to work through moving things from the OpenStack organization on GitHub or having the "forked from" metadata on the repo. If there's an empty repo, I can just push everything to that.
Sure thing. That's done. I've invited Sorin to the organization but I don't know your GitHub username to add you, Stephen.
Stephen
[1] https://review.opendev.org/#/c/564453/
On Tue, Jul 16, 2019 at 10:44 AM Stephen Finucane <stephen@that.guru> wrote:
On Sat, 2019-07-13 at 12:26 -0500, Ian Stapleton Cordasco wrote:
On Sat, Jul 13, 2019 at 12:23 PM Stephen Finucane < stephen@that.guru> wrote:
Hi,
I'd like to explore the idea of adopting the 'doc8' tool within the PyCQA organization. For anyone not familiar with the tool, 'doc8' markets itself as "an opinionated style checker for rst (with basic support for plain text) styles of documentation." It's currently maintained within the OpenStack community but there have been some valid concerns raised recently regarding the health of the 'doc8' tool [1]. While it is extensively used within OpenStack (and outside it too, fwiw), it's very much secondary to the core goal of OpenStack itself, which probably explains the lack of attention it's received over the last few years.
While 'doc8' is not a checker for Python code itself, it is Python- based, is a "quality tool", and rST+docutils/Sphinx remains the documentation tool of choice for the Python community. For this reason, I think PyCQA might be a good fit as a parent organization. The other possible parent organizations I've been looking at are sphinx- doc/sphinx-contrib and docutils, but doc8 isn't actually Sphinx-based, which kind of rules out the former, while the docutils community are _still_ insisting on Sourceforge and Subversion, ruling them out :(
Does anyone else think PyCQA might possibly make a good fit for 'doc8'? If so, I'll raise the idea formally within OpenStack and start on the paperwork to move things across. If not, I'd welcome other ideas for where this useful project could live.
Stephen
[1] http://lists.openstack.org/pipermail/openstack-discuss/2019-July/007669.html
I thiink it's definitely a fit given its focus. I don't know that there's anyone in the PyCQA, however, who has the cycles to maintain it. Would you and Sorin be willing to maintain it inside the PyCQA? I'd be happy to set things up so that you both could add more maintainers easily.
Yeah, that would be the expectation, though I would hope that some other interested parties might eventually discover the project and pitch in, of course (wishful thinking, perhaps :)).
What are the next steps?
Stephen
Cheers, Ian
On Thu, 2019-07-18 at 18:24 -0500, Ian Stapleton Cordasco wrote:
On Thu, Jul 18, 2019 at 8:04 AM Stephen Finucane <stephen@that.guru> wrote:
On Thu, 2019-07-18 at 07:36 -0500, Ian Stapleton Cordasco wrote:
I'm not sure. Bandit, however, completed the transition a few years ago. I suspect there are clues in Gerrit and on the mailing list archives here and there. Once y'all have a GitHub repository you'd like to move over. You can either add me to it so I can move it into the org or I can make the teams, make y'all moderators and I _think_ that will give you the ability to move it yourselves.
Sure, I'll get a move on with this now, starting with a mail to openstack-discuss (just sent) and a patch based on [1]. Instead of moving a repo across though, perhaps you could just create an empty 'pycqa/doc8' repo that we can populate, adding us an admins in the process? This means we don't have to work through moving things from the OpenStack organization on GitHub or having the "forked from" metadata on the repo. If there's an empty repo, I can just push everything to that.
Sure thing. That's done. I've invited Sorin to the organization but I don't know your GitHub username to add you, Stephen.
Thanks for adding me. Having discussed this on #openstack-infra, it seems the preferred option is to actually move the 'openstack/doc8' repo on GitHub so we get the free redirects. Ian - would it be okay if we moved the repo to your personal account (sigmavirus24), meaning you could then move it to 'PyQCA' and set the appropriate permissions. This is what I've had to do for Sphinx and OVS stuff in the past. If that's okay, I'll talk to the infra guys and get them to do that. Sorry for the confusion. Too many cooks, or something like that /o\ Stephen
On Fri, Jul 19, 2019 at 9:47 AM Stephen Finucane <stephen@that.guru> wrote:
On Thu, 2019-07-18 at 18:24 -0500, Ian Stapleton Cordasco wrote:
On Thu, Jul 18, 2019 at 8:04 AM Stephen Finucane <stephen@that.guru> wrote:
On Thu, 2019-07-18 at 07:36 -0500, Ian Stapleton Cordasco wrote:
I'm not sure. Bandit, however, completed the transition a few years ago. I suspect there are clues in Gerrit and on the mailing list archives here and there. Once y'all have a GitHub repository you'd like to move over. You can either add me to it so I can move it into the org or I can make the teams, make y'all moderators and I _think_ that will give you the ability to move it yourselves.
Sure, I'll get a move on with this now, starting with a mail to openstack-discuss (just sent) and a patch based on [1]. Instead of moving a repo across though, perhaps you could just create an empty 'pycqa/doc8' repo that we can populate, adding us an admins in the process? This means we don't have to work through moving things from the OpenStack organization on GitHub or having the "forked from" metadata on the repo. If there's an empty repo, I can just push everything to that.
Sure thing. That's done. I've invited Sorin to the organization but I don't know your GitHub username to add you, Stephen.
Thanks for adding me. Having discussed this on #openstack-infra, it seems the preferred option is to actually move the 'openstack/doc8' repo on GitHub so we get the free redirects. Ian - would it be okay if we moved the repo to your personal account (sigmavirus24), meaning you could then move it to 'PyQCA' and set the appropriate permissions. This is what I've had to do for Sphinx and OVS stuff in the past. If that's okay, I'll talk to the infra guys and get them to do that.
Sorry for the confusion. Too many cooks, or something like that /o\
Stephen
If they would prefer to move it to my personal account we can make that work. Otherwise, I think I can probably add them to the doc8 team so they can just move it directly to the PyCQA org (or you or Sorin could add them to the team so I'm not the bottleneck).
On Fri, 2019-07-19 at 15:47 +0100, Stephen Finucane wrote:
On Thu, 2019-07-18 at 18:24 -0500, Ian Stapleton Cordasco wrote:
On Thu, Jul 18, 2019 at 8:04 AM Stephen Finucane <stephen@that.guru> wrote:
On Thu, 2019-07-18 at 07:36 -0500, Ian Stapleton Cordasco wrote:
I'm not sure. Bandit, however, completed the transition a few years ago. I suspect there are clues in Gerrit and on the mailing list archives here and there. Once y'all have a GitHub repository you'd like to move over. You can either add me to it so I can move it into the org or I can make the teams, make y'all moderators and I _think_ that will give you the ability to move it yourselves.
Sure, I'll get a move on with this now, starting with a mail to openstack-discuss (just sent) and a patch based on [1]. Instead of moving a repo across though, perhaps you could just create an empty 'pycqa/doc8' repo that we can populate, adding us an admins in the process? This means we don't have to work through moving things from the OpenStack organization on GitHub or having the "forked from" metadata on the repo. If there's an empty repo, I can just push everything to that.
Sure thing. That's done. I've invited Sorin to the organization but I don't know your GitHub username to add you, Stephen.
Thanks for adding me. Having discussed this on #openstack-infra, it seems the preferred option is to actually move the 'openstack/doc8' repo on GitHub so we get the free redirects. Ian - would it be okay if we moved the repo to your personal account (sigmavirus24), meaning you could then move it to 'PyQCA' and set the appropriate permissions. This is what I've had to do for Sphinx and OVS stuff in the past. If that's okay, I'll talk to the infra guys and get them to do that.
Sorry for the confusion. Too many cooks, or something like that /o\
This is mostly all done now. I think I just need to be added as an admin to either the team or the repo so I can do things like merge patches and configure Travis. Thanks for the help! Stephen
I'll double check those settings but it may be that the repo isn't in the right team Sent from my phone with my typo-happy thumbs. Please excuse my brevity On Wed, Jul 24, 2019, 06:03 Stephen Finucane <stephen@that.guru> wrote:
On Fri, 2019-07-19 at 15:47 +0100, Stephen Finucane wrote:
On Thu, 2019-07-18 at 18:24 -0500, Ian Stapleton Cordasco wrote:
On Thu, Jul 18, 2019 at 8:04 AM Stephen Finucane <stephen@that.guru> wrote:
On Thu, 2019-07-18 at 07:36 -0500, Ian Stapleton Cordasco wrote:
I'm not sure. Bandit, however, completed the transition a few years ago. I suspect there are clues in Gerrit and on the mailing list archives here and there. Once y'all have a GitHub repository you'd like to move over. You can either add me to it so I can move it into the org or I can make the teams, make y'all moderators and I _think_ that will give you the ability to move it yourselves.
Sure, I'll get a move on with this now, starting with a mail to openstack-discuss (just sent) and a patch based on [1]. Instead of moving a repo across though, perhaps you could just create an empty 'pycqa/doc8' repo that we can populate, adding us an admins in the process? This means we don't have to work through moving things from the OpenStack organization on GitHub or having the "forked from" metadata on the repo. If there's an empty repo, I can just push everything to that.
Sure thing. That's done. I've invited Sorin to the organization but I don't know your GitHub username to add you, Stephen.
Thanks for adding me. Having discussed this on #openstack-infra, it seems the preferred option is to actually move the 'openstack/doc8' repo on GitHub so we get the free redirects. Ian - would it be okay if we moved the repo to your personal account (sigmavirus24), meaning you could then move it to 'PyQCA' and set the appropriate permissions. This is what I've had to do for Sphinx and OVS stuff in the past. If that's okay, I'll talk to the infra guys and get them to do that.
Sorry for the confusion. Too many cooks, or something like that /o\
This is mostly all done now. I think I just need to be added as an admin to either the team or the repo so I can do things like merge patches and configure Travis. Thanks for the help!
Stephen
On 7/13/19 11:26 AM, Ian Stapleton Cordasco wrote:
Does anyone else think PyCQA might possibly make a good fit for 'doc8'? If so, I'll raise the idea formally within OpenStack and start on the paperwork to move things across. If not, I'd welcome other ideas for where this useful project could live.
Stephen
[1] http://lists.openstack.org/pipermail/openstack-discuss/2019-July/007669.html
I thiink it's definitely a fit given its focus. I don't know that there's anyone in the PyCQA, however, who has the cycles to maintain it. Would you and Sorin be willing to maintain it inside the PyCQA? I'd be happy to set things up so that you both could add more maintainers easily.
I haven't done anything within this org except join the mailing list and lurk, but I might be able to give some time to such a project. There'd be a learning curve, natch, so this is just to say I'm here, not that I'd be any immediate help.
participants (3)
-
Ian Stapleton Cordasco -
Mats Wichmann -
Stephen Finucane