I gave a short talk today about new coders and contributors to developer documentation today. Here are my notes!<\/p>\n
Me: Selena Deckelmann Data Architect, Mozilla Major contributor to PostgreSQL, PyLadies organizer in Portland, OR<\/p>\n
Focusing on Documentation, Teaching and Outreach<\/p>\n
Two main forks of thought around teaching and outreach: 1. Brand new coders: PyLadies, Software Carpentry and University are the main communities represented 2. New contributors to Python & ecosystem<\/p>\n
1. Brand new coders: PyLadies, Software Carpentry and University are the main communities represented<\/strong><\/p>\n (a) Information architecture of the website<\/em><\/p>\n Where do you go if you are a teacher or want to teach a workshop? Totally unclear on python.org. Really could use a section on the website for this, microsite.<\/p>\n Version 2 vs 3 is very confusing for new developers. Most workshops default to 2, some workshops now require 3. Maybe mark clearly on all workshops which version. Generally this is a very confusing issue when encountering the site for the first time.<\/p>\n Possible solution: Completely separate “brand new coder” tutorial. Jessica McKellar would like to write this.<\/p>\n (b) Packaging and Installation problems<\/em> — see earlier long conversation in this meeting about this. Many problems linked to having to compile C code while installing with pip<\/p>\n (c) New coder contribution can come through documenting of issues around install and setup.<\/em> We could make this easier — maybe direct initial reports to stack overflow, and then float solutions to bugs.python.org<\/p>\n 2. New contributors to Python & ecosystem — with a focus on things useful for keeping documentation and tutorials up-to-date and relevant<\/strong><\/p>\n (a) GNOME Outreach Program for Women<\/em> – Python is participating<\/a>!<\/p>\n More people from core should participate as mentors! PSF is funding 2-3 students this cycle, Twisted has participated for a while and had a great experience. This program is great because:<\/p>\n Jessica McKellar and Lynn Root are mentors for Python itself. See them for more details about this round! Selena is a coordinator and former mentor for Mozilla’s participation and also available to answer questions.<\/p>\n (b) Write the Docs conference<\/a><\/em> is a python-inspired community around documentation.<\/p>\n (c) Openstack – Anne Gentle & her blog<\/a>.<\/em> 3-year participant in OpenStack community and great resource for information about building technical documentation community.<\/p>\n (d) Better tooling for contribution could be a great vector for getting new contributors<\/em>.<\/p>\n (e) bugs.python.org<\/a><\/em><\/p>\n Type selection is not relevant to ‘documentation’ errors\/fixes. Either remove ‘type’ from the UI or provide relevant types. I recommend removing ‘type’ as a required (or implied required) form field when entering a bug.<\/p>\n The larger issue here is around how we design for contribution of docs:<\/p>\n Also see the “tooling for contribution”<\/p>\n","protected":false},"excerpt":{"rendered":" I gave a short talk today about new coders and contributors to developer documentation today. Here are my notes! Me: Selena Deckelmann Data Architect, Mozilla Major contributor to PostgreSQL, PyLadies organizer in Portland, OR Focusing on Documentation, Teaching and Outreach … Continue reading →<\/a><\/p>\n","protected":false},"author":1,"featured_media":0,"comment_status":"open","ping_status":"open","sticky":false,"template":"","format":"standard","meta":{"footnotes":""},"categories":[407],"tags":[],"class_list":["post-5188","post","type-post","status-publish","format-standard","hentry","category-python"],"_links":{"self":[{"href":"https:\/\/www.chesnok.com\/daily\/wp-json\/wp\/v2\/posts\/5188","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/www.chesnok.com\/daily\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/www.chesnok.com\/daily\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/www.chesnok.com\/daily\/wp-json\/wp\/v2\/users\/1"}],"replies":[{"embeddable":true,"href":"https:\/\/www.chesnok.com\/daily\/wp-json\/wp\/v2\/comments?post=5188"}],"version-history":[{"count":6,"href":"https:\/\/www.chesnok.com\/daily\/wp-json\/wp\/v2\/posts\/5188\/revisions"}],"predecessor-version":[{"id":5195,"href":"https:\/\/www.chesnok.com\/daily\/wp-json\/wp\/v2\/posts\/5188\/revisions\/5195"}],"wp:attachment":[{"href":"https:\/\/www.chesnok.com\/daily\/wp-json\/wp\/v2\/media?parent=5188"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/www.chesnok.com\/daily\/wp-json\/wp\/v2\/categories?post=5188"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/www.chesnok.com\/daily\/wp-json\/wp\/v2\/tags?post=5188"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}\n
\n
\n