[openstack-dev] [docs][ptl] Candidacy for Docs
Hi all, I'd like to announce my candidacy for PTL of the docs project for Queens. I've been active in various open source documentation and translation projects since 2007 and started contributing to OpenStack docs during the Mitaka cycle, both upstream and in the RDO Project. The docs project has recently seen a significant decrease in both the number of submitted updates and contributors, but thanks to a group of dedicated people in the community, we've managed to come up with a clear plan to migrate docs over to individual projects, restructure them and reduce the scope to keep them maintainable. This is now well underway and I'd like to help the team and the community drive and continue with this work. In docs, we generally like to keep it rather short and simple, so let me summarize the main three points as follows: Support and help drive the remaining tasks in restructuring and/or moving content from the core docs suite. Help establish the docs team as content editors for individual project docs when needed or requested. Stay open and friendly to new contributors, no matter if they are prospective core members or drive-by docs contributors, with the understanding that docs are a great way to get involved in the project for both the non- and developers. Thank you, pk -- Petr Kovar Sr. Technical Writer | Customer Content Services Red Hat Czech, Brno __ 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] [Docs] PTL Candidacy
-BEGIN PGP SIGNED MESSAGE- Hash: SHA256 Hi everyone, I am seeking re-election as Documentation PTL for Newton. I have now been the docs PTL for two releases (Liberty and Mitaka), and would love another term in the middle of the alphabet! We've achieved a lot this time around, including an almost complete conversion to RST, quite a few structural overhauls of popular books, and some fundamental toolchain improvements. There is still lots to be done, though, and I would love your support to achieve this in Newton. During Liberty we got the bulk of our books migrated away from Docbook XML and into RST. In Mitaka, we completed that work (with only the Ops Guide remaining to be converted in Newton). For the last couple of releases, we've also had a focus on improving the information architecture of our books, and have now successfully completed overhauls of our most popular books, with the Architecture Guide also well underway. All of these tasks will be carried over to Newton, with many of them finally coming to completion. In Newton, I would also like to address some of the larger issues around the organisation of our documentation suite, making it easier for developers to contribute quality code to our docs, and better welcoming and introducing new big tent projects to the documentation team. At the Mitaka summit in Tokyo, we decided to make a concerted effort to pay down a lot of our tech debt, and one of the main ways we chose to do that was to change the way we handled the DocImpact flag in our bugs. We merged those changes to DocImpact about a month ago now, and it is already having a significant impact on the amount of untriaged bugs outstanding. We're now much more able to keep on top of our bug queue, which is giving us a much greater ability to pay down tech debt. In this vein, we also have put a lot of effort into ensuring new contributors have a better onboarding experience to docs, with the creation of our new Contributor Guide which replaces a lot of old wiki-based content, a great 'get started with docs' campaign at the last Summit (which resulted in a hard copy article in the Summit edition of SuperUser, and Anne and I on SuperUser TV), and a general willingness to respond to questions on the mailing lists and help out new users wherever we find them. In the Liberty release cycle, we closed just over 600 bugs, and we're very close to matching that number for Mitaka, with 505 bugs closed as I write this. Again, we've managed to keep on top of the aging bugs as well, with all bugs older than a year now closed. In the Mitaka release, we managed to close 16 blueprints, which is a massive increase over Liberty's 7. I'm very excited about making the trek to Austin soon for the Newton summit, to catch up with old friends, and hopefully meet some of our newest contributors. Please be sure to stop for a chat if you see me around :) I'd love to have your support for the PTL role for Newton, and I'm looking forward to continuing to grow the documentation team. Thanks, Lana (@loquacities) - -- Lana Brindley Technical Writer Rackspace Cloud Builders Australia http://lanabrindley.com -BEGIN PGP SIGNATURE- Version: GnuPG v2 Comment: Using GnuPG with Thunderbird - http://www.enigmail.net/ iQEcBAEBCAAGBQJW5g++AAoJELppzVb4+KUy9LAH/RC5y/gM22qywGZaE2y4hWEc b+xdCxFUuh41l3WJhQ2iRJrnZUjm84doG2eCIcCpJW/OC5udo+2GiQYGmLUH278A uz8Rfglsu/SmDhWZbaIWtiKXo3WedmWzXUbBCV7/+aftphKLMdckD1KAharZZOWq Jqzg56SjWRqzbO++XiciCVwQ+zgoGuzJzYEQ1SsYsAdp/+wdtO2qPORZO1UuoOfz wFFS/OG8O4PsJa3e9KW/kHzDY3Emkz7bhqDcbE6w3HyszC6bEq8lDgmcXtg2SoNn FzjEpoiiAyalncUfo3p+v+7CV/3M/N4nCB2K+VhYO0hIAxPgUMxhrP3jzzq/gSI= =sboQ -END PGP SIGNATURE- __ 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] [Docs] PTL Candidacy
confirmed On 25/09/14 12:10 AM, Anne Gentle wrote: I'm writing to announce my candidacy for the Documentation Program Technical Lead (PTL). The past six months have flown by. I still recall writing up wish lists per-deliverable on the plane home from the Atlanta Summit and the great news is many are completed. Of course we still have a lot to do. We face many challenges as an open source community as we grow and define ourselves through our users. As documentation specialists, we have to be creative with our resourcing for documentation as the number of teams and services increases each release. This release we have: - experimented with using RST sourcing for a chapter about Heat Templates - managed to keep automating where it makes sense, using the toolset we keep improving upon - held another successful book sprint for the Architecture and Design Guide - split out a repo for the training group focusing not only on training guides but also scripts and other training specialties - split out the Security Guide with their own review team; completed a thorough review of that guide - split out the High Availability Guide with their own review team from discussions at the Ops Meetup - began a Networking Guide pulling together as many interested parties as possible before and after the Ops Meetup with a plan for hiring a contract writer to work on it with the community - added the openstack common client help text to the CLI Reference - added Chinese, German, French, and Korean language landing pages to the docs site - generated config option tables with each milestone release (with few exceptions of individual projects) - lost a key contributor to API docs (Diane's stats didn't decline far yet: http://stackalytics.com/?user_id=diane-flemingrelease=juno) - still working towards a new design for page-based docs - still working on API reference information - still working on removing spec API documents to avoid duplication and confusion - still testing three of four install guides for the JUNO release (that we're nearly there is just so great) So you can see we have much more to do, but we have come so far. Even in compiling this list I worry I'm missing items, there's just so much scope to OpenStack docs. We serve users, deployers, administrators, and app developers. It continues to be challenging but we keep looking for ways to make it work. We have seen amazing contributors like Andreas Jaeger, Matt Kassawara, Gauvain Pocentek, and Christian Berendt find their stride and shine. Yes, I could name more but these people have done an incredible job this release. I'm especially eager to continue collaborating with great managers like Nick Chase at Mirantis and Lana Brindley at Rackspace -- they see what we can accomplish when enterprise doc teams work well with an upstream. They're behind-the-scenes much of the time but I must express my gratitude to these two pros up front. Thanks for your consideration. I'd be honored to continue to serve in this role. Anne ___ OpenStack-dev mailing list OpenStack-dev@lists.openstack.org http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-dev signature.asc Description: OpenPGP digital signature ___ OpenStack-dev mailing list OpenStack-dev@lists.openstack.org http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-dev
[openstack-dev] [Docs] PTL Candidacy
I'm writing to announce my candidacy for the Documentation Program Technical Lead (PTL). The past six months have flown by. I still recall writing up wish lists per-deliverable on the plane home from the Atlanta Summit and the great news is many are completed. Of course we still have a lot to do. We face many challenges as an open source community as we grow and define ourselves through our users. As documentation specialists, we have to be creative with our resourcing for documentation as the number of teams and services increases each release. This release we have: - experimented with using RST sourcing for a chapter about Heat Templates - managed to keep automating where it makes sense, using the toolset we keep improving upon - held another successful book sprint for the Architecture and Design Guide - split out a repo for the training group focusing not only on training guides but also scripts and other training specialties - split out the Security Guide with their own review team; completed a thorough review of that guide - split out the High Availability Guide with their own review team from discussions at the Ops Meetup - began a Networking Guide pulling together as many interested parties as possible before and after the Ops Meetup with a plan for hiring a contract writer to work on it with the community - added the openstack common client help text to the CLI Reference - added Chinese, German, French, and Korean language landing pages to the docs site - generated config option tables with each milestone release (with few exceptions of individual projects) - lost a key contributor to API docs (Diane's stats didn't decline far yet: http://stackalytics.com/?user_id=diane-flemingrelease=juno) - still working towards a new design for page-based docs - still working on API reference information - still working on removing spec API documents to avoid duplication and confusion - still testing three of four install guides for the JUNO release (that we're nearly there is just so great) So you can see we have much more to do, but we have come so far. Even in compiling this list I worry I'm missing items, there's just so much scope to OpenStack docs. We serve users, deployers, administrators, and app developers. It continues to be challenging but we keep looking for ways to make it work. We have seen amazing contributors like Andreas Jaeger, Matt Kassawara, Gauvain Pocentek, and Christian Berendt find their stride and shine. Yes, I could name more but these people have done an incredible job this release. I'm especially eager to continue collaborating with great managers like Nick Chase at Mirantis and Lana Brindley at Rackspace -- they see what we can accomplish when enterprise doc teams work well with an upstream. They're behind-the-scenes much of the time but I must express my gratitude to these two pros up front. Thanks for your consideration. I'd be honored to continue to serve in this role. Anne ___ OpenStack-dev mailing list OpenStack-dev@lists.openstack.org http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-dev
Re: [openstack-dev] [Docs] PTL Candidacy
I support your continued role as the PTL for docs. It’s not always they most glamorous job, and you do a great job at it. You got my vote. Regards, Colin Colin McNamara People | Process | Technology Mobile: 858-208-8105 Twitter:@colinmcnamara Linkedin: www.linkedin.com/in/colinmcnamara Blog: www.colinmcnamara.com Email: co...@2cups.com On Mar 28, 2014, at 11:29 AM, Anne Gentle a...@openstack.org wrote: Hi all, I'm writing to announce my candidacy for the Documentation Program Technical Lead (PTL). I have been working on OpenStack upstream documentation since September 2010, and am currently serving in this role. I recently summarized the many community and collaboration methods we use to create and maintain documentation across the core OpenStack programs. [1] I think these open source, open documentation methods are what keep OpenStack docs vibrant and alive. I can't take credit for all the work that goes on in our community, but please let me highlight the results the coordinated teams and individuals have produced: - The Documentation team has grown and matured in the past release, and we released simultaneously with the code for the first time with the Havana release. We are on track to do that again for Icehouse. - We have a translation toolchain working this year and I'm constantly amazed at the outpouring of dedication from our translation community. - Our coordinated documentation tool chains that enable automation and continuous publication are working seamlessly with the various projects across OpenStack. - We're releasing an O'Reilly edition of the OpenStack Operations Guide. - The API Reference at http://api.openstack.org/api-ref.html got a complete refresh to provide a responsive web design and to streamline the underlying CSS and JS code. - We have been incubating the open source training manuals team within the OpenStack Documentation program. They’ve produced an Associate Training Guide, with outlines and schedules for an Operator Training Guide, a Developer Training Guide, and an Architect Training Guide. - While our focus has been on both Guides for operators and installers as well as API reference documentation, I am interested in working with the app developer community to build documentation collaboratively that fits their needs. Everett Toews recently updated the API docs landing page to take this first step. I hope you can support my continuing efforts for the wide scope and breadth of serving the documentation needs in this community. Thanks, Anne [1] http://justwriteclick.com/2014/03/21/how-to-build-openstack-docs-and-contributors-through-community/ ___ 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] [Docs] PTL Candidacy
Hi all, I'm writing to announce my candidacy for the Documentation Program Technical Lead (PTL). I have been working on OpenStack upstream documentation since September 2010, and am currently serving in this role. I recently summarized the many community and collaboration methods we use to create and maintain documentation across the core OpenStack programs. [1] I think these open source, open documentation methods are what keep OpenStack docs vibrant and alive. I can't take credit for all the work that goes on in our community, but please let me highlight the results the coordinated teams and individuals have produced: - The Documentation team has grown and matured in the past release, and we released simultaneously with the code for the first time with the Havana release. We are on track to do that again for Icehouse. - We have a translation toolchain working this year and I'm constantly amazed at the outpouring of dedication from our translation community. - Our coordinated documentation tool chains that enable automation and continuous publication are working seamlessly with the various projects across OpenStack. - We're releasing an O'Reilly edition of the OpenStack Operations Guide. - The API Reference at http://api.openstack.org/api-ref.html got a complete refresh to provide a responsive web design and to streamline the underlying CSS and JS code. - We have been incubating the open source training manuals team within the OpenStack Documentation program. They've produced an Associate Training Guide, with outlines and schedules for an Operator Training Guide, a Developer Training Guide, and an Architect Training Guide. - While our focus has been on both Guides for operators and installers as well as API reference documentation, I am interested in working with the app developer community to build documentation collaboratively that fits their needs. Everett Toews recently updated the API docs landing page to take this first step. I hope you can support my continuing efforts for the wide scope and breadth of serving the documentation needs in this community. Thanks, Anne [1] http://justwriteclick.com/2014/03/21/how-to-build-openstack-docs-and-contributors-through-community/ ___ OpenStack-dev mailing list OpenStack-dev@lists.openstack.org http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-dev
Re: [openstack-dev] [Docs] PTL Candidacy
confirmed On 03/28/2014 02:29 PM, Anne Gentle wrote: Hi all, I'm writing to announce my candidacy for the Documentation Program Technical Lead (PTL). I have been working on OpenStack upstream documentation since September 2010, and am currently serving in this role. I recently summarized the many community and collaboration methods we use to create and maintain documentation across the core OpenStack programs. [1] I think these open source, open documentation methods are what keep OpenStack docs vibrant and alive. I can't take credit for all the work that goes on in our community, but please let me highlight the results the coordinated teams and individuals have produced: - The Documentation team has grown and matured in the past release, and we released simultaneously with the code for the first time with the Havana release. We are on track to do that again for Icehouse. - We have a translation toolchain working this year and I'm constantly amazed at the outpouring of dedication from our translation community. - Our coordinated documentation tool chains that enable automation and continuous publication are working seamlessly with the various projects across OpenStack. - We're releasing an O'Reilly edition of the OpenStack Operations Guide. - The API Reference at http://api.openstack.org/api-ref.html got a complete refresh to provide a responsive web design and to streamline the underlying CSS and JS code. - We have been incubating the open source training manuals team within the OpenStack Documentation program. They've produced an Associate Training Guide, with outlines and schedules for an Operator Training Guide, a Developer Training Guide, and an Architect Training Guide. - While our focus has been on both Guides for operators and installers as well as API reference documentation, I am interested in working with the app developer community to build documentation collaboratively that fits their needs. Everett Toews recently updated the API docs landing page to take this first step. I hope you can support my continuing efforts for the wide scope and breadth of serving the documentation needs in this community. Thanks, Anne [1] http://justwriteclick.com/2014/03/21/how-to-build-openstack-docs-and-contributors-through-community/ ___ 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
