[openstack-dev] Thanks for all the fish
Hi everyone, As most of you know, I was caught up in the Rackspace layoffs that happened earlier this year, and have been looking for work (in between knee surgery) since then. Well, in good news for my bank account, I have now secured a new job with a startup based here in Brisbane. The bad news is that, while it's working on cool stuff and is likely to be at least partially open sourced at some point, there's currently no scope for me to continue working on OpenStack. Sadly, an OpenStack related position just did not come my way, despite my best efforts. So, this is goodbye for now. I'm going to unsubscribe from the OpenStack mailing lists, and resign my core positions, but you can still email me at this address if you want to. Feel free to hit me up on LinkedIn or Twitter, if that's your thing. I'm going to miss being part of the community we built here, and all the fabulous people I've met over my OpenStack years. Keep being awesome, I'll be cheering from the sidelines. Keep on Doc'ing :) Lana -- Lana Brindley Technical Writer http://lanabrindley.com signature.asc Description: OpenPGP digital 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] Trove is skipped in Newton
>> >> So, if you as a major contributor of Trove and you don't want to write >> documentations, why don't you opensource the book? (Openstack Trove) >> and make life easer for operators ? >> > > [Amrith Kumar] Apart from being factually incorrect, your comment is quite > funny. All of the documentation for Trove was contributed by members of the > Trove community, many from Tesora but also HP, Rackspace, EBay, IBM, RedHat, > SUSE, Cisco, Mirantis, and a lot of other independent contributors, may of > who are also from deployers of Trove. This includes the documentation now > available on how to build guest images. Making the book open source or free > on the internet won't make life easier. Like the suggestions and ideas I gave > you on IRC, they are just recommendations. The book is, for all intents and > purposes, free for anyone who asks nicely. > There's also installation documentation on docs.openstack.org: https://docs.openstack.org/project-install-guide/database/ocata/ This content is owned and maintained by the OpenStack Trove team (and lives in the Trove repo). The docs team publish it as part of the OpenStack Install Guide. Anyone can propose a patch against the guide if they find errors. Lana -- Lana Brindley Technical Writer Rackspace Cloud Builders Australia http://lanabrindley.com signature.asc Description: OpenPGP digital signature ___ Mailing list: http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack Post to : openstack@lists.openstack.org Unsubscribe : http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack
[openstack-dev] Fwd: Documentation logo - revised
And here's our logo with our whole name written on it :) L Forwarded Message Subject:Documentation logo - revised Date: Fri, 17 Feb 2017 13:30:26 -0800 From: Heidi Joy Tretheway <heidi...@openstack.org> To: Alexandra Settle <a.set...@outlook.com>, Lana Brindley <openst...@lanabrindley.com> Here are the updated files for Documentation! Have a great weekend. https://www.dropbox.com/sh/htu234yuf963i9b/AAAsraXwT3a5O9HNmms4E9yFa?dl=0 photo *Heidi Joy Tretheway* Senior Marketing Manager, OpenStack Foundation 503 816 9769 | Skype: heidi.tretheway <https://webapp.wisestamp.com/sig_iframe?origin=mac-mail_id=5499768844845056=0.9726545857097719#> <http://linkedin.com/in/heiditretheway> <http://twitter.com/heiditretheway> <http://www.openstack.org/> signature.asc Description: OpenPGP digital 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
[openstack-dev] Fwd: Docs project mascot
Hi everyone, Here's the final docs logo from Foundation. Lana Forwarded Message Subject:Docs project mascot Date: Mon, 13 Feb 2017 13:38:46 -0800 From: Heidi Joy Tretheway <heidi...@openstack.org> To: Alexandra Settle <a.set...@outlook.com>, Lana Brindley <openst...@lanabrindley.com> Hi Lana and Alexandra, I’m excited to finally be able to share final project logo files with you. Inside this folder, you’ll find full-color and one-color versions of the logo, plus a mascot-only version, in EPS, JPG and PNG formats. You can use them on presentations and wherever else you’d like to add some team flair. https://www.dropbox.com/sh/htu234yuf963i9b/AAAsraXwT3a5O9HNmms4E9yFa?dl=0 At the PWG, we’ll have stickers for your team of the mascot, plus signage on your room. I’m especially excited for the project teams to see all of the logos together as one group, because they work beautifully together stylistically while making each project’s mark distinctive. Feel free to share this with your team, and thanks to you and to them for the hard work they put into reaching an agreement on the mascot. Also feel free to direct any questions my way! photo *Heidi Joy Tretheway* Senior Marketing Manager, OpenStack Foundation 503 816 9769 | Skype: heidi.tretheway <https://webapp.wisestamp.com/sig_iframe?origin=mac-mail_id=5499768844845056=0.9726545857097719#> <http://linkedin.com/in/heiditretheway> <http://twitter.com/heiditretheway> <http://www.openstack.org/> signature.asc Description: OpenPGP digital 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] [All] IRC Mishaps
On 09/02/17 06:36, Kendall Nelson wrote: > Hello All! > > So I am sure we've all seen it: people writing terminal commands into our > project channels, misusing '/' commands, etc. But have any of you actually > done it? > > If any of you cores, ptls or other upstanding members of our wonderful > community have had one of these embarrassing experiences please reply! I am > writing an article for the SuperUser trying to make us all seem a little more > human to people new to the community and new to using IRC. It can be scary > asking questions to such a large group of smart people and its even more off > putting when we make mistakes in front of them. > > So please share your stories! What about the one where you're conducting a private conversation in one window, and watching a group chat in another one, and then drop some deeply personal (or embarrassing!) content in the group chat instead the PM ;) L -- Lana Brindley Technical Writer Rackspace Cloud Builders Australia http://lanabrindley.com signature.asc Description: OpenPGP digital 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] [openstack-docs][security] Sec guide change
Nice work! L On 03/02/17 05:06, Alexandra Settle wrote: > Hi everyone, > > > > As of today, all bugs for the Security Guide will be managed by > ossp-security-documentation and no longer will be tracked using the OpenStack > manuals Launchpad. > > > > All tracking for Security Guide related bugs can be found here: > https://bugs.launchpad.net/ossp-security-documentation > > > > Big thanks to the security team and Ian Cordasco for creating and updating > the bug list in Launchpad! > > > > Thank you, > > > > Alex > > > > __ > 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 > -- Lana Brindley Technical Writer Rackspace Cloud Builders Australia http://lanabrindley.com signature.asc Description: OpenPGP digital 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] [all][elections] PTL nomination period is now over
Yes, I replied on the other thread. Thanks :) L On 30/01/17 16:48, Kendall Nelson wrote: > Yes of course :) Did you want to schedule a meeting or just discuss here > more? > > I've seen some discussion about making UX to a working group? > > -Kendall (diablo_rojo) > > On Sun, Jan 29, 2017, 7:46 PM Lana Brindley <openst...@lanabrindley.com > <mailto:openst...@lanabrindley.com>> wrote: > > Hi Kendall, > > I'd like to discuss the future of the UX project with you, if that's OK? > > Lana > > On 30/01/17 11:05, Kendall Nelson wrote: > > Hello All! > > > > PTL Nomination is now over. The official candidate list is available on > the election website[0]. > > > > There is only 1project without candidates, so according to this > resolution[1], the TC we'll have to appoint a new PTL for OpenStack UX. > > > > There are 5projects that will have an election: Ironic, Keystone, > Neutron, Quality Assurance and Stable Branch Maintenance.The details for > those will be posted shortly after we setup the CIVS system. > > > > Thank you, > > > > [0]: http://governance.openstack.org/election/# > <http://governance.openstack.org/election/#pike-ptl-candidates>pike > <http://governance.openstack.org/election/#pike-ptl-candidates>-ptl-candidates > <http://governance.openstack.org/election/#pike-ptl-candidates> > > [1]: > http://governance.openstack.org/resolutions/20141128-elections-process-for-leaderless-programs.html > > > > > > > __ > > OpenStack Development Mailing List (not for usage questions) > > Unsubscribe: > openstack-dev-requ...@lists.openstack.org?subject:unsubscribe > <http://openstack-dev-requ...@lists.openstack.org?subject:unsubscribe> > > http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-dev > > > > -- > Lana Brindley > Technical Writer > Rackspace Cloud Builders Australia > http://lanabrindley.com > > __ > OpenStack Development Mailing List (not for usage questions) > Unsubscribe: > openstack-dev-requ...@lists.openstack.org?subject:unsubscribe > <http://openstack-dev-requ...@lists.openstack.org?subject:unsubscribe> > http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-dev > > > > __ > 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 > -- Lana Brindley Technical Writer Rackspace Cloud Builders Australia http://lanabrindley.com signature.asc Description: OpenPGP digital 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] Supporting our global community
Jonathon, Mark, Lauren, and the rest of the Foundation staff, Thank you for this important note. Is Foundation able to provide some concrete assurance that they will continue to ensure that availability of visas is to be prioritised for future OpenStack events? Additionally, that you will not run events in countries that do not reflect OpenStack values of diversity? Lana On 30/01/17 04:34, Jonathan Bryce wrote: > OpenStack is a global open source community. The OpenStack Foundation serves > members in 180 countries focused on advancing the capabilities and > accessibility of open infrastructure everywhere. We fundamentally believe > diversity and collaboration are a powerful force for innovation, and it has > been amazing to see the product of tens of thousands of people around the > world over the last 6+ years. > > Lauren, Mark and I disagree with the executive order issued by President > Trump that targets individuals from 7 countries. The order restricts the > travel and movement of people in a discriminatory way that results in a > restriction on access to talent and ideas. It is still unclear how the > policies will play out and be enforced, but we will be watching, advocating > for and supporting our community members to the best of our ability. > > This executive order will not impact the governance of the Foundation or the > way the community operates globally. We will continue to support user groups > and community members that are active in the seven countries named by the > executive order, alongside our 120+ user groups around the world. However, we > have two scheduled events in the United States within the next six months > that will attract a global audience: the PTG (Project Teams Gathering) in > Atlanta, Feb 20-24, a smaller event that will bring together hundreds of > upstream contributors, and the OpenStack Summit in Boston, May 8-11, our > larger event that happens every six months. > > This executive order could impact some community members' ability to travel > to Atlanta and Boston, but unfortunately it is too late at this point to > change the location of these events. The following three OpenStack Summits, > however, are now scheduled to occur outside of the United States. The next > Summit will be in November 2017 in Sydney, Australia and we are working to > finalize the details so we can announce the following two Summit locations > soon. > > We’ve already heard from one community member, Mohammed Naser, who is > concerned that his plans to travel from Canada to Atlanta to attend the PTG > may be restricted, simply because he a dual citizen of Canada and Iraq. > Mohammed has been contributing code to OpenStack since 2011 and is the CEO > and Founder of Vexxhost. Blocking his travel would serve no purpose and rob > the community of a valuable contributor during an important event. If you are > concerned about the impact or have any questions, please don't hesitate to > reach out to me at jonat...@openstack.org. > > Political actions like this highlight the importance of our collective > values. The Four Opens, the founding principles of our community, exist to > ensure the free flow of talent and ideas, across geographic, national, > organizational or other lines that might divide us. We believe in humanity. > We believe in opportunity. We believe in the power of collaboration across > borders, and we will continue to carry forward our mission. > > We also posted this online: > https://www.openstack.org/blog/2017/01/supporting-our-global-community/ > > Jonathan Bryce > Mark Collier > Lauren Sell > > > > __ > 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 > -- Lana Brindley Technical Writer Rackspace Cloud Builders Australia http://lanabrindley.com signature.asc Description: OpenPGP digital 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] [ux] Future of the OpenStack UX team
Hi Thierry, Sorry for not noticing this thread and replying earlier. I've now reviewed the minutes from the meeting, and I support thingee's suggestion of having a UX working group. This way, UX can get the attention it rightly deserves. Without the research and guidelines provided by the UX team, user-facing projects (such as Docs) will be poorer. I believe that it's in Foundations best interests to ensure that UX work is ongoing, and adequately supported, in the same way as Marketing and other user outreach services. I am happy to work with Foundation (on behalf of the Docs team) to determine how this would work in practice. Thanks, Lana On 05/01/17 00:43, Thierry Carrez wrote: > Hi everyone, > > Piet recently reached out to me to explain that he won't be able to > continue in his role as OpenStack UX team's PTL. Since he created the > team and spent a lot of time coordinating its activities, that raises > the question of the future of the OpenStack UX team. > > The situation was discussed at the TC meeting yesterday[1] and the > general feeling was that there was a lot of value in a separate team > centralizing things like Persona definition and facilitating > properly-conducted UX surveys. That said, if nobody is able to dedicate > the time that effort needs, we could also disband the centralized team > and encourage every project to adopt the tools and techniques that were > built and introduced by the UX team in the past years. > > So... What are your thoughts on those options ? Do we have a volunteer > (or more than one) to take over UX PTLship ? > > [1] > http://eavesdrop.openstack.org/meetings/tc/2017/tc.2017-01-03-20.00.log.html#l-404 > -- Lana Brindley Technical Writer Rackspace Cloud Builders Australia http://lanabrindley.com signature.asc Description: OpenPGP digital 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] [all][elections] PTL nomination period is now over
On 30/01/17 14:15, Steve Martinelli wrote: > On Sun, Jan 29, 2017 at 8:05 PM, Kendall Nelson <kennelso...@gmail.com > <mailto:kennelso...@gmail.com>> wrote: > > PTL Nomination is now over. The official candidate list is available on > the election website[0]. > > > It's great to see only 1 project was without a PTL! > > > There is only 1project without candidates, so according to this > resolution[1], the TC we'll have to appoint a new PTL for OpenStack UX. > > > The UX project was briefly discussed at a recent TC meeting (see the end of > the log) [1], with Piet stepping down there was some discussion about whether > or not it needs to be a standalone project, or can turn into a working group > (like the API working group). > > Oh, Thierry sent something out to the mailing list already [2], no replies :( > > [1] > http://eavesdrop.openstack.org/meetings/tc/2017/tc.2017-01-03-20.00.log.html > [2] > http://lists.openstack.org/pipermail/openstack-dev/2017-January/109622.html > Ah, thanks Steve. I'll digest this and then reply on that thread :) Lana -- Lana Brindley Technical Writer Rackspace Cloud Builders Australia http://lanabrindley.com signature.asc Description: OpenPGP digital 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] [all][elections] PTL nomination period is now over
Hi Kendall, I'd like to discuss the future of the UX project with you, if that's OK? Lana On 30/01/17 11:05, Kendall Nelson wrote: > Hello All! > > PTL Nomination is now over. The official candidate list is available on the > election website[0]. > > There is only 1project without candidates, so according to this > resolution[1], the TC we'll have to appoint a new PTL for OpenStack UX. > > There are 5projects that will have an election: Ironic, Keystone, Neutron, > Quality Assurance and Stable Branch Maintenance.The details for those will be > posted shortly after we setup the CIVS system. > > Thank you, > > [0]: http://governance.openstack.org/election/# > <http://governance.openstack.org/election/#pike-ptl-candidates>pike > <http://governance.openstack.org/election/#pike-ptl-candidates>-ptl-candidates > <http://governance.openstack.org/election/#pike-ptl-candidates> > [1]: > http://governance.openstack.org/resolutions/20141128-elections-process-for-leaderless-programs.html > > > __ > 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 > -- Lana Brindley Technical Writer Rackspace Cloud Builders Australia http://lanabrindley.com signature.asc Description: OpenPGP digital 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] [OpenStack-docs] What's Up, Doc? Farewell edition
Thanks Shilla, it was a pleasure :) L On 27/01/17 14:27, Shilla Saebi wrote: > We will miss you Lana, you did a phenomenal job and welcome aboard Alexandra! > > On Thu, Jan 26, 2017 at 8:17 PM, Lana Brindley <openst...@lanabrindley.com > <mailto:openst...@lanabrindley.com>> wrote: > > Hi everyone, > > I must confess, I'm feeling a little sad. This is my very last What's Up, > Doc. Next week, I'll be handling the Docs PTL mantle to Alexandra Settle. > I've worked with Alex in varying capacities over many years, and I have no > doubt that she will be a fabulous PTL. I'm really looking forward to working > with her, and seeing what new directions she's able to take this team. I want > to take this opportunity to thank each and every one of you for your > continued support and encouragement over the last two years (and almost-four > releases!). I have had an absolute ball doing this job, and it's all because > of the amazing people I get to work with every day. Of course, I'm not going > anywhere just yet. I will stay on as a core contributor, and continue to help > out as much as I can. > > In the meantime, we have a release to get out the door! We now only have > 26 days until Ocata is released, please keep an eye on the docs mailing list > for updates, and consider getting your hands dirty with some Install Guide > testing: https://wiki.openstack.org/wiki/Documentation/OcataDocTesting > <https://wiki.openstack.org/wiki/Documentation/OcataDocTesting> > > == Progress towards Ocata == > > 26 days to go! > > Closed 211 bugs so far. > > Release tasks are being tracked here: > https://wiki.openstack.org/wiki/Documentation/OcataDeliverables > <https://wiki.openstack.org/wiki/Documentation/OcataDeliverables> > Install Guide testing is being tracked here: > https://wiki.openstack.org/wiki/Documentation/OcataDocTesting > <https://wiki.openstack.org/wiki/Documentation/OcataDocTesting> > > == The Road to PTG in Atlanta == > > Event info is available here: http://www.openstack.org/ptg > Purchase tickets here: https://pikeptg.eventbrite.com/ > <https://pikeptg.eventbrite.com/> > > Docs is a horizontal project, so our sessions will run across the Monday > and Tuesday of the event. We will be combining the docs event with i18n, so > translators and docs people will all be in the room together. > > Conversation topics for Docs and i18n here: > https://etherpad.openstack.org/p/docs-i18n-ptg-pike > <https://etherpad.openstack.org/p/docs-i18n-ptg-pike> > > Also, a quick note that the CFP and ticket sales for *Boston in May* are > now open: > https://www.openstack.org/summit/boston-2017/call-for-presentations/ > <https://www.openstack.org/summit/boston-2017/call-for-presentations/> > > == Speciality Team Reports == > > No speciality team reports this week, as we didn't have quorum for the > docs meeting. > > == Doc team meeting == > > Our next meeting will be on Thursday 9 February at 2100 UTC in > #openstack-meeting-alt > > Meeting chair will be Alexandra Settle. > > For more meeting details, including minutes and the agenda: > https://wiki.openstack.org/wiki/Meetings/DocTeamMeeting > <https://wiki.openstack.org/wiki/Meetings/DocTeamMeeting> > > -- > > Keep on doc'ing! > > Lana > > https://wiki.openstack.org/wiki/Documentation/WhatsUpDoc#27_January_2017 > <https://wiki.openstack.org/wiki/Documentation/WhatsUpDoc#27_January_2017> > > -- > Lana Brindley > Technical Writer > Rackspace Cloud Builders Australia > http://lanabrindley.com > > > ___ > OpenStack-docs mailing list > openstack-d...@lists.openstack.org > <mailto:openstack-d...@lists.openstack.org> > http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-docs > <http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-docs> > > -- Lana Brindley Technical Writer Rackspace Cloud Builders Australia http://lanabrindley.com signature.asc Description: OpenPGP digital 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] What's Up, Doc? Farewell edition
On 27/01/17 12:08, Chris Smart wrote: > On Fri, Jan 27, 2017 at 11:17:11AM +1000, Lana Brindley wrote: >> Hi everyone, >> >> I must confess, I'm feeling a little sad. This is my very last What's Up, >> Doc. Next week, I'll be handling the Docs PTL mantle to Alexandra Settle. >> I've worked with Alex in varying capacities over many years, and I have no >> doubt that she will be a fabulous PTL. I'm really looking forward to working >> with her, and seeing what new directions she's able to take this team. I >> want to take this opportunity to thank each and every one of you for your >> continued support and encouragement over the last two years (and almost-four >> releases!). I have had an absolute ball doing this job, and it's all because >> of the amazing people I get to work with every day. Of course, I'm not going >> anywhere just yet. I will stay on as a core contributor, and continue to >> help out as much as I can. >> > > Congrats Alex, I'm confident you will do a fabulous job! > > > Lana, from what I've seen you've been a great PTL and it will be great > to still have you around. Thanks for your leadership and support! Great > job. > > > -c > d'aww, thanks Chris :) L -- Lana Brindley Technical Writer Rackspace Cloud Builders Australia http://lanabrindley.com signature.asc Description: OpenPGP digital 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
[openstack-dev] What's Up, Doc? Farewell edition
Hi everyone, I must confess, I'm feeling a little sad. This is my very last What's Up, Doc. Next week, I'll be handling the Docs PTL mantle to Alexandra Settle. I've worked with Alex in varying capacities over many years, and I have no doubt that she will be a fabulous PTL. I'm really looking forward to working with her, and seeing what new directions she's able to take this team. I want to take this opportunity to thank each and every one of you for your continued support and encouragement over the last two years (and almost-four releases!). I have had an absolute ball doing this job, and it's all because of the amazing people I get to work with every day. Of course, I'm not going anywhere just yet. I will stay on as a core contributor, and continue to help out as much as I can. In the meantime, we have a release to get out the door! We now only have 26 days until Ocata is released, please keep an eye on the docs mailing list for updates, and consider getting your hands dirty with some Install Guide testing: https://wiki.openstack.org/wiki/Documentation/OcataDocTesting == Progress towards Ocata == 26 days to go! Closed 211 bugs so far. Release tasks are being tracked here: https://wiki.openstack.org/wiki/Documentation/OcataDeliverables Install Guide testing is being tracked here: https://wiki.openstack.org/wiki/Documentation/OcataDocTesting == The Road to PTG in Atlanta == Event info is available here: http://www.openstack.org/ptg Purchase tickets here: https://pikeptg.eventbrite.com/ Docs is a horizontal project, so our sessions will run across the Monday and Tuesday of the event. We will be combining the docs event with i18n, so translators and docs people will all be in the room together. Conversation topics for Docs and i18n here: https://etherpad.openstack.org/p/docs-i18n-ptg-pike Also, a quick note that the CFP and ticket sales for *Boston in May* are now open: https://www.openstack.org/summit/boston-2017/call-for-presentations/ == Speciality Team Reports == No speciality team reports this week, as we didn't have quorum for the docs meeting. == Doc team meeting == Our next meeting will be on Thursday 9 February at 2100 UTC in #openstack-meeting-alt Meeting chair will be Alexandra Settle. For more meeting details, including minutes and the agenda: https://wiki.openstack.org/wiki/Meetings/DocTeamMeeting -- Keep on doc'ing! Lana https://wiki.openstack.org/wiki/Documentation/WhatsUpDoc#27_January_2017 -- Lana Brindley Technical Writer Rackspace Cloud Builders Australia http://lanabrindley.com signature.asc Description: OpenPGP digital 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
[openstack-dev] What's Up, Doc? 13 January
Hi everyone, Welcome to 2017. I hope you all had a chance to rest up a little before we hurtle straight into another release, as Ocata is now only 40 days away! I'll be in contact with our lovely release managers Brian and Mariia over the next week or so to kick off release management tasks. We will need people to test the Installation Guide again, too, so if you're interested in helping out there, please let me know. As many of you already know, I'm not planning on running for Pike PTL. PTL nominations open in the week of 23 January, and I'll be working with Alex and Kato-san who have both expressed interest in taking on this role. If you're interested in running for PTL (for Pike or any future release), and would like a crash course in PTLing, please let me know and I can share whatever meagre wisdom I've gleaned. == Progress towards Ocata == 40 days to go! Closed 149 bugs so far. Deliverables are being tracked here: https://wiki.openstack.org/wiki/Documentation/OcataDeliverables == The Road to PTG in Atlanta == Event info is available here: http://www.openstack.org/ptg Purchase tickets here: https://pikeptg.eventbrite.com/ Docs is a horizontal project, so our sessions will run across the Monday and Tuesday of the event. We will be combining the docs event with i18n, so translators and docs people will all be in the room together. The incoming PTL will be responsible for planning and running sessions at the Atlanta PTG. Also, a quick note that the CFP and ticket sales for *Boston* in May are now open: https://www.openstack.org/summit/boston-2017/call-for-presentations/ == Speciality Team Reports == * API: Anne Gentle Fairy-slipper is being retired. It was a good tool, served its purpose, and can now traipse into the sunset, thanks to AJaeger and stevemar for the help with the patches. Be sure to follow the service catalog naming conventions work going on in the API WG. And there's also a new EC2 API reference: http://developer.openstack.org/api-ref/ec2-api/ * Configuration Reference and CLI Reference: Tomoyuki Kato Config Reference: Updated a few plug-ins. CLI reference: Updated a few command references and removed unsupported Block Storage API v1 and Image API v1. * High Availability Guide: Andrew Beekhof No report this week * Hypervisor Tuning Guide: Joe Topjian No report this week * Installation guides: Lana Brindley Testing for Ocata will be opening soon. Also, we need a web dev for the landing page, if you know of anyone, please get me in touch. * Networking Guide: John Davidge No update this week. * Operations and Architecture Design guides: Darren Chan Ben Silverman has spent some time refining the Compute content in the Arch Guide draft. Thanks Ben! We are also looking for more SMEs to help with the Arch Guide. So if you're interested, contact asettle or me. * Security Guide: Nathaniel Dillon No update this week. * Training Guides: Matjaz Pancur No update this week. * Training labs: Pranav Salunke, Roger Luethi No update this week. * User guides: Joseph Robinson The command conversions have happened at a good pace, the User Guide appears to be mostly complete, with the condition that the trove and manila teams do not have OpenStack commands yet. I have started checking through the Admin Guide files. I suspect there is more to convert, but it should be ready for Ocata. == Doc team meeting == Our next meeting will be on Thursday 27 January at 2100 UTC in #openstack-meeting-alt For more meeting details, including minutes and the agenda: https://wiki.openstack.org/wiki/Meetings/DocTeamMeeting -- Keep on doc'ing! Lana https://wiki.openstack.org/wiki/Documentation/WhatsUpDoc#13_January_2017 -- Lana Brindley Technical Writer Rackspace Cloud Builders Australia http://lanabrindley.com signature.asc Description: OpenPGP digital 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] Stepping down from core
On 22/12/16 02:11, Matt Kassawara wrote: > Howdy! > > After several years of contributing to OpenStack documentation, a significant > change in my career path warrants resigning from my role as a core reviewer. > Working with the OpenStack community was a great experience and I hope it > continues to grow... with sufficient documentation, of course. > > Cheers, > Matt > Thanks for all your dedication and hard work over many years, Matt. Without you (and Tom!) I would never have gotten my first docs patch in, so I owe you a lot :) All the best for the next step in your big adventure. Lana -- Lana Brindley Technical Writer Rackspace Cloud Builders Australia http://lanabrindley.com signature.asc Description: OpenPGP digital 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
[openstack-dev] What's Up, Doc? Holiday Edition!
Hi everyone, The end of the year is nearly upon us already, and this will be my last newsletter for 2016, before I disappear for the holidays on the 16th. I've had yet another wonderful year with all you lovely OpenStack people, and I wish all of you and your families a happy and safe holiday, wherever and however you celebrate it. Here in Australia, the temperature is starting to soar, so I'm off on another cruise, followed by a few lazy days by the pool with family and friends. I'll be back in the office early in the new year, and ready to kick Ocata out of the door! As many of you already know, I'm not planning on running for Pike PTL. If you're interested in running for PTL (for Pike or any future release), and would like a crash course in PTLing, please let me know and I can share whatever meagre wisdom I've gleaned before self nominations open in mid-January. == Progress towards Ocata == 82 days to go! Closed 106 bugs so far. Release tasks are being tracked here: https://wiki.openstack.org/wiki/Documentation/OcataDeliverables == The Road to PTG in Atlanta == Event info is available here: http://www.openstack.org/ptg Purchase tickets here: https://pikeptg.eventbrite.com/ Docs is a horizontal project, so our sessions will run across the Monday and Tuesday of the event. The incoming PTL will be responsible for planning and running sessions at the Atlanta PTG. == Speciality Team Reports == * API: Anne Gentle The App Dev Support WG is working on a survey to determine which content areas to invest in for content on http://www.openstack.org/appdev (http://lists.openstack.org/pipermail/user-committee/2016-November/001469.html) * Configuration Reference and CLI Reference: Tomoyuki Kato We try to recreating the single page view for the "openstack" command. I'd like to generate the reference from source code automatically. However, python-openstackclient has many plug-ins. It is difficulty, but worth to tackle it. We need your help! * High Availability Guide: Andrew Beekhof No formal report, but Alex Settle has been doing a lot of work on this guide recently, cleaning up, and raising bugs for some of the TODO items. We need to consider if the HA guide is an ongoing concern. Ben Silverman is wondering if we can fold the content into the Ops/Arch Guides. This will be raised on the mailing list for more conversation. * Hypervisor Tuning Guide: Joe Topjian No report this week * Installation guides: Lana Brindley We've heard back from Foundation on design resources, I'm going to reply to that email today and hopefully start drafting the new design next week. I've also got Piet from the UX team on board to help. Anyone who wants to be involved with that, please contact me. * Networking Guide: John Davidge No update this week. * Operations and Architecture Design guides: Darren Chan For the Arch guide, patches for networking and compute content were merged, thanks to Ben and Shaun. For the Ops Guide, there is patch up to update the upgrades chapter and include links to the project upgrade notes: https://review.openstack.org/#/c/404528/ * Security Guide: Nathaniel Dillon No update this week. * Training Guides: Matjaz Pancur BCN Upstream training article in the Superuser magazine: http://superuser.openstack.org/articles/openstack-upstream-training-revamp/ - actively looking for contributors to join the Upstream training, please see http://lists.openstack.org/pipermail/openstack-docs/2016-November/009382.html - cleaned test entries in the Launchpad bug queue and the Sandbox repository (left from the Barcelona Upstream training) - updated Training guides README.rst * Training labs: Pranav Salunke, Roger Luethi No update this week. * User guides: Joseph Robinson The legacy command conversion continues at a good pace. I have some more updates to patch today. The only obstacle I have run into is generating new output to match the OpenStack command client. Otherwise, contributors have been adding to the table, and there's been steady patching completed. Just a reminder to update the table if making a change: https://wiki.openstack.org/wiki/Documentation/ReorganizeUserGuides == Doc team meeting == Our next meeting will be on Thursday 16 December at 2100 UTC in #openstack-meeting-alt For more meeting details, including minutes and the agenda: https://wiki.openstack.org/wiki/Meetings/DocTeamMeeting -- Keep on doc'ing! Lana https://wiki.openstack.org/wiki/Documentation/WhatsUpDoc#1_December_2016 -- Lana Brindley Technical Writer Rackspace Cloud Builders Australia http://lanabrindley.com signature.asc Description: OpenPGP digital 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] [OpenStack-docs] [osa] [docs] OpenStack-Ansible deploy guide live!
On 01/12/16 01:03, Alexandra Settle wrote: > Hi everyone, > > > > I am really pleased to announce that the OpenStack-Ansible Deployment Guide > is now available on the docs.o.o website! You can view it in all its glory > here: http://docs.openstack.org/project-deploy-guide/newton/ > > > > This now paves the way for many other deployment projects to publish their > deployment guides on the docs.o.o website, under “Deployment Guides” > <http://docs.openstack.org/> and gain more visibility. > > Nice work! :) L -- Lana Brindley Technical Writer Rackspace Cloud Builders Australia http://lanabrindley.com signature.asc Description: OpenPGP digital 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
[openstack-dev] What's Up, Doc? 18 November
Hi everyone, Welcome to Ocata! It was great to catch up with many of you in Barcelona, and always refreshing to see the energy around our little project and catch that enthusiasm all over again :) Of course, Ocata is a *very* short cycle, so we've deliberately cut down our deliverables list to ensure we can squeeze it all in. We have two main priorities this release: tidying up the new Install Guides index page, and a little bit of navel gazing in terms of social structures and procedures. More on that in this newsletter! == Progress towards Ocata == 96 days to go! Closed 77 bugs so far. Release tasks are being tracked here: https://wiki.openstack.org/wiki/Documentation/OcataDeliverables == The Road to PTG in Atlanta == Event info is available here: http://www.openstack.org/ptg Purchase tickets here: https://pikeptg.eventbrite.com/ Docs is a horizontal project, so our sessions will run across the Monday and Tuesday of the event. == Specs on review == * Ops/Arch Guides: https://review.openstack.org/#/c/392372/ [arch-design] Revise the Architecture Design Guide https://review.openstack.org/#/c/394261/ [ops-guide] Add project upgrade notes https://review.openstack.org/#/c/391786/ Proposed use case form * Training Labs: https://review.openstack.org/#/c/391548/ training-labs: Rewrite training-labs in python == Speciality Team Reports == We've made some structural changes to how Speciality Teams and our regular docs meeting work. Speciality teams will now meet no more than once monthly (most on an 'as needed' basis), and participants are instead encouraged to attend the main docs meeting to discuss work and report on progress. This is aiming to keep all the information about the work we're doing a little more centralised, and give newcomers a way to find out where they can best help. It also gives us a chance to find out where we can help each other, without going to a dozen meetings! * API: Anne Gentle Karen Bradshaw has been working on updates to the openstackdocstheme that would fix this bug: https://launchpad.net/bugs/1583623. The review is up at https://review.openstack.org/#/c/393890/ and getting input from the affected teams who have recognized the need because of errors building when you have multiple API versions with very similar calls, so you end up with identical headings. Launchpad bug 1583623 in openstack-doc-tools "os-api-ref: duplicate labels for selectors" [Low,In progress] - Assigned to Karen Bradshaw (kbhawkey) I've had a couple of inquiries on IRC about "where did the draft/swagger files go?" but to meet their stated end goals, those particular files wouldn't have worked any way due to inaccuracies in the content and incomplete content. See the 100 api-ref doc patches up for review at: https://review.openstack.org/#/q/status:open+file:api-ref. * Configuration Reference and CLI Reference: Tomoyuki Kato No report this week * High Availability Guide: Andrew Beekhof No report this week * Hypervisor Tuning Guide: Joe Topjian No report this week * Installation guides: Lana Brindley No major updates to the guides themselves, but we are planning updates to the landing page. We're also working on getting our first deployment guide landed there, with OpenStack Ansible. I've requested design resources from foundation, but haven't heard back yet, so if you have ideas/suggestions (or design skillz!) then please let me know. * Networking Guide: John Davidge A couple of new articles are close to merging: https://review.openstack.org/#/c/361776/ - VLAN Trunking and https://review.openstack.org/#/c/356013/ - Routed Provider Networks. Need to decide how best to track the work that's going on for https://blueprints.launchpad.net/openstack-manuals/+spec/use-openstack-command. Probably a google spreadsheet or etherpad with a list of all the network guide pages to be converted, and the person working on it would be best. That way we can hopefully avoid duplicating efforts. * Operations and Architecture Design guides: Darren Chan We're slowly making progress with the arch guide, and have cloudnull onboard to help. So the focus is completing the design chapter and migrating stuff from the ops guide. * Security Guide: Nathaniel Dillon No update this week. * Training Guides: Matjaz Pancur We changed our IRC meeting to every two weeks (on even weeks) on Tuesday at 1300 UTC in #openstack-meeting-3. There will be an article published about BCN Upstream training in OpenStack's Superuser magazine. BCN Upstream training retrospective https://etherpad.openstack.org/p/upstream-training-barcelona-retrospective * Training labs: Pranav Salunke, Roger Luethi We have the python port already under review, the spec is not done yet, but we hope to get them merged soonish and in the right order :) User guides: Joseph Robinson * This the current work on converting the legacy commands to OS commands: https://wiki.openstack.or
Re: [openstack-dev] [Docs] Changes to docs speciality teams, meetings, and reporting
We now have a new docs meeting time, every second Thursday 2100, starting next week, on 18 November. See you there! L On 04/11/16 11:23, Lana Brindley wrote: > Hi everyone, > > There was a long-running and wide-ranging conversation during Summit about > community engagement in the docs team, most formally at the 'Social Things' > session[1], and culminating in the 'Ocata Planning' session[2] on the last > day. I suggest you read those etherpads if you weren't at the sessions. This > was a major part of my PTL candidacy platform for Ocata, and I'm excited that > we had so much productive conversation, complete with some action items that > we can implement immediately. > > First of all, we have seen a drop off in both docs mailing list traffic and > docs meeting conversation over the past twelve months or so, even though > contributions have remained steady (for the openstack-manuals repo). This is > attributed partially to a much-improved Contributor Guide (meaning we spend > less time on answering the same questions over and over), and but it's also > apparently because conversation is splintering off into speciality team > groups, rather than happening in the wider context of the docs group as a > whole. > > So, while speciality teams are definitely valued and important, especially > when it comes to directing and completing specific work items, we have come > up with a few smaller changes we can make to try and improve our sense of > community: > > * Speciality team meetings are now going to be restricted to once per month, > or on an as-needed basis. > * The docs meeting will change to a single Euro/APAC timed meeting, every > second week, probably around 2100 UTC (to be confirmed). > * I will no longer be asking speciality team leads for a written report for > the newsletter. Instead, please attend the docs meeting and report there. If > you are not able to attend, you will have the option to provide a written > report ahead of time to be presented by a proxy. > * The newsletter will go to every second week, timed to be after the docs > meeting, and will contain speciality team reports and other updates from that > meeting. > > I would like your feedback on these changes, especially if you didn't get a > chance to participate in the conversation at Summit. > > I will be implementing these changes over the next week or so, and there will > be further opportunity for you to express your opinion on these changes as > we go. > > Lana > > 1: https://etherpad.openstack.org/p/BCN-Docs-Social > 2: https://etherpad.openstack.org/p/BCN-Docs-OcataPlanningWG > -- Lana Brindley Technical Writer Rackspace Cloud Builders Australia http://lanabrindley.com signature.asc Description: OpenPGP digital 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
[openstack-dev] [Docs] Changes to docs speciality teams, meetings, and reporting
Hi everyone, There was a long-running and wide-ranging conversation during Summit about community engagement in the docs team, most formally at the 'Social Things' session[1], and culminating in the 'Ocata Planning' session[2] on the last day. I suggest you read those etherpads if you weren't at the sessions. This was a major part of my PTL candidacy platform for Ocata, and I'm excited that we had so much productive conversation, complete with some action items that we can implement immediately. First of all, we have seen a drop off in both docs mailing list traffic and docs meeting conversation over the past twelve months or so, even though contributions have remained steady (for the openstack-manuals repo). This is attributed partially to a much-improved Contributor Guide (meaning we spend less time on answering the same questions over and over), and but it's also apparently because conversation is splintering off into speciality team groups, rather than happening in the wider context of the docs group as a whole. So, while speciality teams are definitely valued and important, especially when it comes to directing and completing specific work items, we have come up with a few smaller changes we can make to try and improve our sense of community: * Speciality team meetings are now going to be restricted to once per month, or on an as-needed basis. * The docs meeting will change to a single Euro/APAC timed meeting, every second week, probably around 2100 UTC (to be confirmed). * I will no longer be asking speciality team leads for a written report for the newsletter. Instead, please attend the docs meeting and report there. If you are not able to attend, you will have the option to provide a written report ahead of time to be presented by a proxy. * The newsletter will go to every second week, timed to be after the docs meeting, and will contain speciality team reports and other updates from that meeting. I would like your feedback on these changes, especially if you didn't get a chance to participate in the conversation at Summit. I will be implementing these changes over the next week or so, and there will be further opportunity for you to express your opinion on these changes as we go. Lana 1: https://etherpad.openstack.org/p/BCN-Docs-Social 2: https://etherpad.openstack.org/p/BCN-Docs-OcataPlanningWG -- Lana Brindley Technical Writer Rackspace Cloud Builders Australia http://lanabrindley.com signature.asc Description: OpenPGP digital 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] [OpenStack-docs] [ironic] Admin guide in-tree?
Hi Jay, I think that's a perfectly reasonable solution for the moment, and hopefully we'll have the new solution up and running as soon as possible. Please let us know if there's anything you could use a hand with. Lana On 12/10/16 09:00, Jay Faulkner wrote: > We are eager to improve our documentation, but I think quite a few of us who > work on Ironic documentation have a strong preference to keeping those > documents in-tree. This allows us to enforce contributors having > documentation changes or additions merge at the same time or in close > proximity to the code changes and is much easier for us to interact with. I > have the willingness to help implement admin guides in-tree sooner, but if > the docs team doesn't want this yet obviously there's nothing to help with. > > As for what to do today today; I agree with Ruby on this entirely. I'm adding > an item to Monday's Ironic meeting agenda to reach consensus on what our > project will do in the meantime. My recommendation will be option B as listed > by Ruby; build out a better admin-guide in tree as part of our developer > docs, and migrate them over, just like we did for the install guide, when the > work to allow in-tree admin guides is complete. > > Thanks, > Jay Faulkner > >> On Oct 11, 2016, at 9:38 AM, Ruby Loo <opensr...@gmail.com >> <mailto:opensr...@gmail.com>> wrote: >> >> From my point of view, the rush is so that we can be more efficient with all >> of our time/efforts. In ironic, we have a bit of a mess. We now have >> duplicated (and perhaps out-of-sync) admin-related information in our >> developer docs [1] as well as in the official admin guide [2] -- the latter >> content was added but I am unaware of that knowledge/coordination being done >> with the ironic community :-( >> >> Should we : >> A. move our admin-related information from our developer docs to the >> existing admin guide; then move the admin guide to the new in-tree solution >> later >> >> B. replace what is in the existing admin guide with a pointer to the >> developer docs; then move the admin content to the new in-tree solution later >> >> C. status quo until the new in-tree solution is available >> >> --ruby >> >> [1] http://docs.openstack.org/developer/ironic/ >> [2] http://docs.openstack.org/admin-guide/baremetal.html >> >> >> On Mon, Oct 10, 2016 at 7:07 PM, Lana Brindley <openst...@lanabrindley.com >> <mailto:openst...@lanabrindley.com>> wrote: >> >> On 10/10/16 16:25, Andreas Jaeger wrote: >> > On 2016-10-10 01:37, Steve Martinelli wrote: >> >> On Oct 9, 2016 6:57 PM, "Lana Brindley" <openst...@lanabrindley.com >> <mailto:openst...@lanabrindley.com> >> >> <mailto:openst...@lanabrindley.com >> <mailto:openst...@lanabrindley.com>>> wrote: >> >>> >> >>> Why the rush? >> >> >> >> I think its more eagerness than rush. Project teams made a lot of head >> >> way with the API ref and install guides being in-tree that they want >> to >> >> keep the momentum with the admin guide. >> > >> > Those teams are more than welcome to contribute today to the >> > openstack-manuals repository! Is there anything we can help these? >> > >> > Andreas >> > >> >> Yes, Andreas makes a good point. If there's content you want in the >> guides now, we can help you with that. >> >> Lana >> >> -- >> Lana Brindley >> Technical Writer >> Rackspace Cloud Builders Australia >> http://lanabrindley.com <http://lanabrindley.com/> >> >> >> >> __ >> OpenStack Development Mailing List (not for usage questions) >> Unsubscribe: >> openstack-dev-requ...@lists.openstack.org?subject:unsubscribe >> <http://openstack-dev-requ...@lists.openstack.org/?subject:unsubscribe> >> http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-dev >> <http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-dev> >> >> >> ______ >> OpenStack Development Mailing List (not for usage questions) >> Unsubscribe: openstack-dev-requ...@lists.openstack.org >> <mailto:openstack-dev-requ...@lists.openstack.org>?subject:unsubscribe >> http://lists.openstack.org/cgi-bin/ma
Re: [openstack-dev] [OpenStack-docs] Admin guide in-tree?
On 10/10/16 16:25, Andreas Jaeger wrote: > On 2016-10-10 01:37, Steve Martinelli wrote: >> On Oct 9, 2016 6:57 PM, "Lana Brindley" <openst...@lanabrindley.com >> <mailto:openst...@lanabrindley.com>> wrote: >>> >>> Why the rush? >> >> I think its more eagerness than rush. Project teams made a lot of head >> way with the API ref and install guides being in-tree that they want to >> keep the momentum with the admin guide. > > Those teams are more than welcome to contribute today to the > openstack-manuals repository! Is there anything we can help these? > > Andreas > Yes, Andreas makes a good point. If there's content you want in the guides now, we can help you with that. Lana -- Lana Brindley Technical Writer Rackspace Cloud Builders Australia http://lanabrindley.com signature.asc Description: OpenPGP digital 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] [OpenStack-docs] Admin guide in-tree?
On 10/10/16 09:37, Steve Martinelli wrote: > On Oct 9, 2016 6:57 PM, "Lana Brindley" <openst...@lanabrindley.com > <mailto:openst...@lanabrindley.com>> wrote: >> >> Why the rush? > > I think its more eagerness than rush. Project teams made a lot of head way > with the API ref and install guides being in-tree that they want to keep the > momentum with the admin guide. > That makes sense, and I really appreciate the enthusiasm. I'll take these concerns to the Summit, and if the docs team decide that we need to take advantage of that and push ahead in the Ocata cycle, then I'll go with it. Lana -- Lana Brindley Technical Writer Rackspace Cloud Builders Australia http://lanabrindley.com signature.asc Description: OpenPGP digital 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] [OpenStack-docs] Admin guide in-tree?
Thanks for the offer. The scope of the work is probably not huge, based on what we know from the Install Guide. We should be able to more or less copy what we did there. However, I want to collect data based on that experience before we begin, rather than barrelling on down that road. Additionally, I don't feel as though the Install Guide is absolutely complete until we've got the index page done. As I said earlier, there is also the consideration of the short release cycle for Ocata. One point I will make, though, that is with a Pike schedule, you would have Admin Guides up under this model by the Pike release date (about twelve months from now). We planned the Install Guides at the Austin summit, and have published them with Newton. Why the rush? Lana On 08/10/16 02:13, Jay Faulkner wrote: > I'm not necessarily just asking for it to be done -- I'm curious what the > scope of work is because I'm potentially willing to help (and find folks to > help) get it done sooner. If the docs team does not support the admin guide > in-tree until Pike, It'll be Q or later before other projects can utilize it. > That's over a year from today, and I'd rather not have to wait that long to > get a better admin guide up for Ironic. > > Thanks, > Jay Faulkner > OSIC > >> On Oct 6, 2016, at 8:04 PM, Lana Brindley <openst...@lanabrindley.com> wrote: >> >> (Adding the dev list to cc, as I think this conversation deserves a wider >> audience) >> >> Thanks for this feedback. I'm really glad that the new Install Guide model >> is working out well for people! >> >> Since our new Install Guides have only just been published, at this stage >> I'm intending to gather some data on how projects and users are using the >> project-specific Install Guides during the next cycle. I'm also intending to >> spend some time in the Ocata cycle on improving that index page. It's pretty >> ugly right now, and I think there's some serious UX improvements to be >> done. Since Ocata is a short cycle, I'm also conscious of how much the docs >> team might realistically be able to achieve. >> >> All that said, you are certainly not the first to ask if this model can be >> extended! I think it's something that the docs community would like to see, >> and it seems as though it has broad support amongst developers and projects >> as well. So, in short, I think this is a thing that will happen, but >> probably not in Ocata. I'm tentatively willing to tell you that Pike is a >> possibility though ;) >> >> Lana >> >> On 07/10/16 12:43, Steve Martinelli wrote: >>> FWIW, the keystone team would also be interested in this model >>> >>> On Thu, Oct 6, 2016 at 11:40 AM, Jay Faulkner <j...@jvf.cc >>> <mailto:j...@jvf.cc>> wrote: >>> >>>Hi all, >>> >>>For those of you who don't know me, I'm Jay Faulkner and I work on >>> Ironic as the Docs liaison as one of my hats. >>> >>>Ironic launched our install-guide right after newton closed, and >>> backported it, thanks to the changes to make the install-guide available in >>> tree. We're a huge fan of this model, and I'm curious if there's any plans >>> to make this happen for the admin-guide. If not, can someone help me >>> understand the scope of work, presuming it's something that the docs group >>> is interested in. >>> >>>If we can get the technical infrastructure in place to do admin-guide in >>> tree, I'd expect Ironic to quickly adopt it, like we did for the install >>> guide. >>> >>>Thanks, >>>Jay Faulkner >>>OSIC >>> >>> >>>___ >>>OpenStack-docs mailing list >>>openstack-d...@lists.openstack.org >>> <mailto:openstack-d...@lists.openstack.org> >>>http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-docs >>> <http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-docs> >>> >>> >>> >>> >>> ___ >>> OpenStack-docs mailing list >>> openstack-d...@lists.openstack.org >>> http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-docs >>> >> >> -- >> Lana Brindley >> Technical Writer >> Rackspace Cloud Builders Australia >> http://lanabrindley.com >> >> ___ >> OpenStack-docs mailing list >> openstack-d...@lists.openstack.org >> http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-docs > -- Lana Brindley Technical Writer Rackspace Cloud Builders Australia http://lanabrindley.com signature.asc Description: OpenPGP digital 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
[openstack-dev] What's Up, Doc? Newton Edition!
Hi everyone, First of all, Newton docs are live on http://docs.openstack.org/ \o/ Thank you to our release managers, Olena and Alex, who have put in the hard yards over the past few weeks to get us in good shape. Thanks also to Andreas and Kato-san, for everything that they do, and to our speciality team leads and cross project liaisons. And thanks to Christian and Matt for the last minute assistance. Of course, every release belongs to all of you who have written, tested, reviewed, updated, triaged, and edited over the last six months. Well done on another successful release :) Don't forget that you can still use "#success" before a message in any OpenStack IRC channel to call out wins, they are gathered here: https://wiki.openstack.org/wiki/Successes == Progress towards Newton == Newton has been released unto the world. We fixed 479 bugs this cycle, and completed 15 blueprints. We'll begin planning for Ocata over the next couple of weeks, culminating in the Barcelona Summit 25-28 October, where we'll develop our Ocata deliverables list. Stay tuned! == The Road to Barcelona == Our docs schedule is now available here: https://www.openstack.org/summit/barcelona-2016/summit-schedule/global-search?t=Documentation%3A We are also hoping to have a docs session in the Ops track. I'll get back to you with more information on that as soon as I have it. I've requested a docs track at the PTG in Atlanta next February, which will be used for Ocata review and Pike planning. Please let me know if you intend to participate. == Core Team Reviews == Just a quick note that we won't be holding a core team review in November, as it conflicts with Summit. We'll resume these in December for the Ocata cycle. == Doc team meeting == We will take a short break and resume the normal meeting schedule after Summit. In the meantime, you can catch most of us in #openstack-doc in a variety of timezones, so feel free to drop in and ask questions any time. -- Keep on doc'ing! Lana https://wiki.openstack.org/wiki/Documentation/WhatsUpDoc#7_October_2016 -- Lana Brindley Technical Writer Rackspace Cloud Builders Australia http://lanabrindley.com signature.asc Description: OpenPGP digital 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] [OpenStack-docs] Admin guide in-tree?
(Adding the dev list to cc, as I think this conversation deserves a wider audience) Thanks for this feedback. I'm really glad that the new Install Guide model is working out well for people! Since our new Install Guides have only just been published, at this stage I'm intending to gather some data on how projects and users are using the project-specific Install Guides during the next cycle. I'm also intending to spend some time in the Ocata cycle on improving that index page. It's pretty ugly right now, and I think there's some serious UX improvements to be done. Since Ocata is a short cycle, I'm also conscious of how much the docs team might realistically be able to achieve. All that said, you are certainly not the first to ask if this model can be extended! I think it's something that the docs community would like to see, and it seems as though it has broad support amongst developers and projects as well. So, in short, I think this is a thing that will happen, but probably not in Ocata. I'm tentatively willing to tell you that Pike is a possibility though ;) Lana On 07/10/16 12:43, Steve Martinelli wrote: > FWIW, the keystone team would also be interested in this model > > On Thu, Oct 6, 2016 at 11:40 AM, Jay Faulkner <j...@jvf.cc > <mailto:j...@jvf.cc>> wrote: > > Hi all, > > For those of you who don't know me, I'm Jay Faulkner and I work on Ironic > as the Docs liaison as one of my hats. > > Ironic launched our install-guide right after newton closed, and > backported it, thanks to the changes to make the install-guide available in > tree. We're a huge fan of this model, and I'm curious if there's any plans to > make this happen for the admin-guide. If not, can someone help me understand > the scope of work, presuming it's something that the docs group is interested > in. > > If we can get the technical infrastructure in place to do admin-guide in > tree, I'd expect Ironic to quickly adopt it, like we did for the install > guide. > > Thanks, > Jay Faulkner > OSIC > > > ___ > OpenStack-docs mailing list > openstack-d...@lists.openstack.org > <mailto:openstack-d...@lists.openstack.org> > http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-docs > <http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-docs> > > > > > ___ > OpenStack-docs mailing list > openstack-d...@lists.openstack.org > http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-docs > -- Lana Brindley Technical Writer Rackspace Cloud Builders Australia http://lanabrindley.com signature.asc Description: OpenPGP digital 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
[openstack-dev] What's Up, Doc? 30 September
Hi everyone, We're on the final countdown to Newton now! The release managers Olena and Alex are busy getting the release patches ready, the Install Guide testing team are madly working through the last few sections, and Andreas and I have our fingers hovering over the big red GO button! Don't forget that you can contact any of us (or just send mail to the docs mailing list) if you have any questions about the Newton docs release. Please be aware that the core team will not be merging non-critical patches until after we've branched for Newton, particularly for the Installation Guide. We usually cut the branch about a week after Summit concludes, so you might be asked to wait until then. If that happens, a core will -2 your patch until after we've branched. == Progress towards Newton == 5 days to go! Bugs closed so far: 466 Release managers: Olena Logvinova and Alexandra Settle Release tasks are being tracked here: https://etherpad.openstack.org/p/NewtonRelease Install Guide testing is being tracked here: https://wiki.openstack.org/wiki/Documentation/NewtonDocTesting == The Road to Barcelona == I have a draft schedule up, which you can see here: https://etherpad.openstack.org/p/Ocata-DocsSessions I'll put this into Sched once the tool becomes available, and your early feedback is welcome. Additionally, if you're interested in moderating a session in Barcelona, please let me know. == Core Team Reviews == Just a quick note that we won't be holding a core team review in October, as it conflicts with release, or in November, as it conflicts with Summit. We'll resume these in December for the Newton cycle. == Doc team meeting == Next meetings: The US meeting was held this week, you can read the minutes here: https://wiki.openstack.org/wiki/Documentation/MeetingLogs#2016-09-28 Next meetings: APAC: Wednesday 5 October, 00:30 UTC (This will be the final meeting before release day!) US: Wednesday 12 October, 19:00 UTC Please go ahead and add any agenda items to the meeting page here: https://wiki.openstack.org/wiki/Meetings/DocTeamMeeting#Agenda_for_next_meeting -- Keep on doc'ing! Lana https://wiki.openstack.org/wiki/Documentation/WhatsUpDoc#30_September_2016 -- Lana Brindley Technical Writer Rackspace Cloud Builders Australia http://lanabrindley.com signature.asc Description: OpenPGP digital 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
[openstack-dev] What's Up, Doc? 23 September
Hi everyone, Newton goes out in just two weeks, and the release team and I have been busy working through release tasks in preparation. Don't forget that you can contact any of us (or just send mail to the docs mailing list) if you have any questions about the Newton docs release. I'm also pleased to announce that I have been returned as the documentation PTL for Ocata, which will be my fourth term. Thanks for all the support! == Progress towards Newton == 12 days to go! Bugs closed so far: 455 Release managers: Olena Logvinova and Alexandra Settle Release tasks are being tracked here: https://etherpad.openstack.org/p/NewtonRelease Install Guide testing is being tracked here: https://wiki.openstack.org/wiki/Documentation/NewtonDocTesting == The Road to Barcelona == * I have a draft schedule starting to take shape, which you can see here: https://etherpad.openstack.org/p/Ocata-DocsSessions I'll put this into Sched once the tool becomes available, and your early feedback is welcome. Additionally, if you're interested in moderating a session in Barcelona, please let me know. * By now, you should be well on the way to having your travel and accommodation booked for Barcelona. In case you're still working on it, though, there's travel information available on the Summit site here: https://www.openstack.org/summit/barcelona-2016/travel/ * Looking a little further forward, Foundation have now announced that the first Project Team Gathering (PTG) will be held in Atlanta, US, on Feb 20-24: http://www.openstack.org/ptg == Doc team meeting == Next meetings: The APAC meeting was skipped this week. Next meetings: US: Wednesday 28 September, 19:00 UTC APAC: Wednesday 5 October, 00:30 UTC These two meetings will be the final meetings before release day. Please go ahead and add any agenda items to the meeting page here: https://wiki.openstack.org/wiki/Meetings/DocTeamMeeting#Agenda_for_next_meeting -- Keep on doc'ing! Lana https://wiki.openstack.org/wiki/Documentation/WhatsUpDoc#23_September_2016 -- Lana Brindley Technical Writer Rackspace Cloud Builders Australia http://lanabrindley.com signature.asc Description: OpenPGP digital 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] [ptl] code churn and questionable changes
On 23/09/16 02:19, Amrith Kumar wrote: > Joshua, > > I think Steve and you may be missing the point of my email. It *IS* because I > want to be open and inviting that I even asked the question, and what I'm > asking for is how to deal with it. > > All Steve says is " The fact that a new-to-openstack contributor would make > such and error doesn’t warrant such a negative response even if it a hassle > for the various PTLs and core reviewer teams to deal with". > > I'm not proposing a negative response, I'm asking how to deal with it. > > What, for example, does one do if a patch is proposed virtually identically > in a half dozen (or two dozen) projects by someone and is totally bat-shit > crazy? Merely -1'ing it and offering to help in a private email is not really > the answer. I've tried it. We all have. And we keep doing it. And doing it again. > > Having a file in the projects repo that talks about guidelines for > contributions isn't it either. We have one of those. It is up to the > contributor to read it; yes, I can keep pointing contributors to that but > this is a systemic problem which I'm hoping to address. It's only systemic in the sense that it's standard human behaviour. And I doubt you'll be able to fix that with some automation. > > What does one do when a contributor continually proposes one line changes > that fix typos in comments (yes, really). At some point, these changes (while > absolutely, and unarguably valid) begin to be a drag on the community. Coach. Train. Communicate. > > What I'm asking for is something, something that may cross project > boundaries, that will help bring contributors onto openstack, and rapidly > bring them to the point where they are contributing at a level that > materially benefits the project(s). > > -amrith > Sounds like you're looking for a technical solution to a social problem. You're the PTL. Make sure there's good documentation about expected behaviours, point to it when you decline a patch, and always be available for mentoring and coaching. Yes, you will teach people the 101 version of contributing a million times over, and you'll repeat yourself ad nauseum, often to the same people. It's called leadership. If you have a truly toxic person in your midst (hint: these are rarely newcomers, you don't discover these people straight away, I've found), *then* you can do something to remove them from your community. Here's a good place to start: https://hypatia.ca/2016/06/21/no-more-rock-stars/ No one said leadership was easy. L -- Lana Brindley Technical Writer Rackspace Cloud Builders Australia http://lanabrindley.com signature.asc Description: OpenPGP digital 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-operators] Docs session in the Ops Track?
That's probably more than we're able to focus on in a session, but if Ops have specific feedback on other docs, that session would be a good time for them to mention it. Otherwise, they can come to relevant sessions in the Docs track instead. Lana On 21/09/16 03:17, Matt Kassawara wrote: > All relevant documentation for operators - which adds at least all of the > material under "Operations and Administration Guides" on d.o.o, the > configuration reference, and API reference. > > On Tue, Sep 20, 2016 at 11:06 AM, Anne Gentle <annegen...@justwriteclick.com > <mailto:annegen...@justwriteclick.com>> wrote: > > > > On Tue, Sep 20, 2016 at 12:01 PM, Matt Kassawara <mkassaw...@gmail.com > <mailto:mkassaw...@gmail.com>> wrote: > > Operators use other documentation besides the operations guide, which > is arguably more of an overview for potential operators than current > operators. Same for the architecture guide. > > > Hi -- You said "focus on all" -- can you be more specific what topics > you'd like? > > Plus, who has the ability to add to the ops track? > > Anne > > > > On Mon, Sep 19, 2016 at 10:01 PM, Lana Brindley > <openst...@lanabrindley.com <mailto:openst...@lanabrindley.com>> wrote: > > What do you mean by that? Can you please elaborate? > > L > > On 20/09/16 13:52, Matt Kassawara wrote: > > Can we focus on all of the potentially relevant documentation? > > > > On Sun, Sep 18, 2016 at 5:34 PM, Lana Brindley > <openst...@lanabrindley.com <mailto:openst...@lanabrindley.com> > <mailto:openst...@lanabrindley.com <mailto:openst...@lanabrindley.com>>> > wrote: > > > > Hi Ops, > > > > For the last few Design Summits, I've run a docs session in > the Ops track, to focus on the Ops Guide (and, to a lesser extent, the > Architecture Guide). Is there interest in doing this again? If so, can I > please grab a slot? > > > > Thanks, > > Lana (Docs PTL) > > > > -- > > Lana Brindley > > Technical Writer > > Rackspace Cloud Builders Australia > > http://lanabrindley.com > > > > > > ___ > > OpenStack-operators mailing list > > OpenStack-operators@lists.openstack.org > <mailto:OpenStack-operators@lists.openstack.org> > <mailto:OpenStack-operators@lists.openstack.org > <mailto:OpenStack-operators@lists.openstack.org>> > > > http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-operators > <http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-operators> > <http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-operators > <http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-operators>> > > > > > > -- > Lana Brindley > Technical Writer > Rackspace Cloud Builders Australia > http://lanabrindley.com > > > > ___ > OpenStack-operators mailing list > OpenStack-operators@lists.openstack.org > <mailto:OpenStack-operators@lists.openstack.org> > > http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-operators > <http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-operators> > > > > > -- > Anne Gentle > www.justwriteclick.com <http://www.justwriteclick.com> > > -- Lana Brindley Technical Writer Rackspace Cloud Builders Australia http://lanabrindley.com signature.asc Description: OpenPGP digital signature ___ OpenStack-operators mailing list OpenStack-operators@lists.openstack.org http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-operators
Re: [Openstack-operators] Docs session in the Ops Track?
What do you mean by that? Can you please elaborate? L On 20/09/16 13:52, Matt Kassawara wrote: > Can we focus on all of the potentially relevant documentation? > > On Sun, Sep 18, 2016 at 5:34 PM, Lana Brindley <openst...@lanabrindley.com > <mailto:openst...@lanabrindley.com>> wrote: > > Hi Ops, > > For the last few Design Summits, I've run a docs session in the Ops > track, to focus on the Ops Guide (and, to a lesser extent, the Architecture > Guide). Is there interest in doing this again? If so, can I please grab a > slot? > > Thanks, > Lana (Docs PTL) > > -- > Lana Brindley > Technical Writer > Rackspace Cloud Builders Australia > http://lanabrindley.com > > > ___ > OpenStack-operators mailing list > OpenStack-operators@lists.openstack.org > <mailto:OpenStack-operators@lists.openstack.org> > http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-operators > <http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-operators> > > -- Lana Brindley Technical Writer Rackspace Cloud Builders Australia http://lanabrindley.com signature.asc Description: OpenPGP digital signature ___ OpenStack-operators mailing list OpenStack-operators@lists.openstack.org http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-operators
[Openstack-operators] Docs session in the Ops Track?
Hi Ops, For the last few Design Summits, I've run a docs session in the Ops track, to focus on the Ops Guide (and, to a lesser extent, the Architecture Guide). Is there interest in doing this again? If so, can I please grab a slot? Thanks, Lana (Docs PTL) -- Lana Brindley Technical Writer Rackspace Cloud Builders Australia http://lanabrindley.com signature.asc Description: OpenPGP digital signature ___ OpenStack-operators mailing list OpenStack-operators@lists.openstack.org http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-operators
[openstack-dev] What's Up, Doc? 16 September
Hi everyone, Newton goes out in three weeks, and the release team and I have been busy working with our cross-project liaisons to ensure the docs suite is up to date and ready to go. Don't forget that you can contact any of us (or just send mail to the docs mailing list) if you have any questions about the Newton docs release. This week, I've also been working on Summit planning, and drafting my PTL candidacy, which you can read here: http://lists.openstack.org/pipermail/openstack-docs/2016-September/009112.html Big thanks to everyone who has emailed me over the past few days to offer their support. Knowing you all have my back is the reason I keep doing this :) == Progress towards Newton == 19 days to go! Bugs closed so far: 444 Release managers: Olena Logvinova and Alexandra Settle Release tasks are being tracked here: https://etherpad.openstack.org/p/NewtonRelease Install Guide testing is being tracked here: https://wiki.openstack.org/wiki/Documentation/NewtonDocTesting == The Road to Barcelona == * I have a draft schedule starting to take shape, which you can see here: https://etherpad.openstack.org/p/Ocata-DocsSessions I'll put this into Sched once the tool becomes available, and your early feedback is welcome. Additionally, if you're interested in moderating a session in Barcelona, please let me know. * By now, you should be well on the way to having your travel and accommodation booked for Barcelona. In case you're still working on it, though, there's travel information available on the Summit site here: https://www.openstack.org/summit/barcelona-2016/travel/ * Looking a little further forward, Foundation have now announced that the first Project Team Gathering (PTG) will be held in Atlanta, US, on Feb 20-24: http://www.openstack.org/ptg == Speciality Team Reports == This will be the last Speciality Team report before we release Newton, as focus shifts to final preparations, testing, and release notes. I'd like to take this opportunity to thank all our speciality team leads, who work very hard behind the scenes to keep their books in top shape, and their teams working together towards a common goal. Our docs suite wouldn't be what it is without these hard working people. '''HA Guide: Andrew Beekhof''' No report this week. '''Install Tutorials: Lana Brindley''' Core Guide testing is underway! Check out progress and sign up here: https://wiki.openstack.org/wiki/Documentation/NewtonDocTesting Next meeting: 27 September August 0600UTC. '''Networking Guide: Edgar Magana''' No report this week. '''Security Guide: Nathaniel Dillon''' No report this week. '''User Guides: Joseph Robinson''' No report this week. '''Ops Guide: Shilla Saebi, Darren Chan''' No report this week. '''API Guide: Anne Gentle''' Working with teams who want to write guides similar to FirstApp: Murano and Heat for example. This patch moves Cinder v1 API to Deprecated: https://review.openstack.org/#/c/370407/ Thanks Mark Voelker for all the links to go with the patch! '''Config/CLI Ref: Tomoyuki Kato''' Updating Config reference for Newton release. We need to help, especially for vendor plug-in configuration. '''Training labs: Pranav Salunke, Roger Luethi''' No report this week. '''Training Guides: Matjaz Pancur''' No report this week. '''Hypervisor Tuning Guide: Blair Bethwaite No report this week. '''UX/UI Guidelines: Michael Tullis, Rodrigo Caballero''' No report this week. == Doc team meeting == Next meetings: The US meeting was held this week, you can read the minutes here: https://wiki.openstack.org/wiki/Documentation/MeetingLogs#2016-09-14 Next meetings: APAC: Wednesday 21 September, 00:30 UTC US: Wednesday 28 September, 19:00 UTC Please go ahead and add any agenda items to the meeting page here: https://wiki.openstack.org/wiki/Meetings/DocTeamMeeting#Agenda_for_next_meeting -- Keep on doc'ing! Lana https://wiki.openstack.org/wiki/Documentation/WhatsUpDoc#16_September_2016 -- Lana Brindley Technical Writer Rackspace Cloud Builders Australia http://lanabrindley.com signature.asc Description: OpenPGP digital 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
[openstack-dev] [Docs][PTL] PTL Candidacy for Docs
Hi everyone, I am seeking re-election as Documentation PTL for Ocata. I have been the docs PTL since Liberty, and together we've converted the entire docs suite to RST, decommissioned the old DocBook infrastructure, and fundamentally changed the way projects document their installation procedures. Ocata is a short cycle, so I want to take this opportunity to focus inwards on our community. I would love your support to do this in Ocata. In Mitaka we embarked on an ambitious plan to convert our entire documentation suite to RST, and in Newton we put the finishing touches to that project by decommissioning the old DocBook infrastructure. With that long-term project complete, we have gone on to develop a new publication model that allows projects to write documentation in their own repos, and publish seamlessly to the docs.openstack.org front page. This project goes live for the Installation Guide and API docs with Newton, and means our documentation efforts are continuing to scale out to represent a much greater proportion of products, contributors, operators, and users. I would like to continue this work in Ocata by evaluating the success of the project, and identifying more efficient and productive pathways for users to find and use the information provided by the docs team. I also want to explore more innovative ways for the documentation team to work together, including a review of the speciality team and release processes. I want to continue to foster collaboration between developers and writers to provide the best possible documentation for the entire OpenStack community. During Newton, in addition to the Installation Guide changes, we focussed on streamlining our processes, clarifying the way we operate, consolidating guides, and general editing and tidying up. I want to continue this work in Ocata to provide a better documentation experience for everyone: writers, developers, operators, and users. In the Liberty release cycle, we closed just over 600 bugs, and in Mitaka we closed 645. With the rate of new bug creation rapidly dropping thanks to procedural changes we made in Mitaka, our consistent effort has really paid down a lot of our technical debt. For Newton so far, we've closed well over 400 bugs, and we have only 327 bugs in the queue as I write this, so this positive trend continues. I'll be making the trek to Barcelona soon for the Ocata 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'm also excited about the new Project Team Gathering coming up in February; I think this will be a great opportunity for cross-project teams like docs. I'd love to have your support for the PTL role for Ocata. I'm looking forward to continuing to grow the documentation team and to keep working on these incremental improvements to content delivery. Thanks, Lana (@loquacities) https://review.openstack.org/#/c/370477/ -- Lana Brindley Technical Writer Rackspace Cloud Builders Australia http://lanabrindley.com signature.asc Description: OpenPGP digital 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
[openstack-dev] What's Up, Doc? 9 September
Hi everyone, Only four weeks to go until Newton! Andreas, Brian, Olga, and I met with our new release managers Olena and Alex a few days ago, and we're all ready and waiting with bated breath to get started on the release. Don't forget that you can contact any of us (or just send mail to the docs mailing list) if you have any questions about the Newton docs release. This week, I've also done a core team review, and we bid farewell to two core team members. More on that in this newsletter. == Progress towards Newton == 26 days to go! Bugs closed so far: 428 Release managers: Olena Logvinova and Alexandra Settle Release tasks are being tracked here: https://etherpad.openstack.org/p/NewtonRelease Install Guide testing is being tracked here: https://wiki.openstack.org/wiki/Documentation/NewtonDocTesting == The Road to Barcelona == * If there's something you want to make sure we discuss at Summit, please put your ideas here: https://etherpad.openstack.org/p/Ocata-DocsSessions When we get our room allocations, I'll organise it into a schedule. * If you require a visa invitation letter to travel to Spain, then you need to fill out the form here: https://www.openstack.org/summit/barcelona-2016/travel/#visa Looking a little further forward, Foundation have now announced that the first Project Team Gathering (PTG) will be held in Atlanta, US, on Feb 20-24: http://www.openstack.org/ptg == Core Team Review == The core team have completed their review for August, and I'm a bit sad to announce that both Atsushi Sakai and Gauvain Pocontek are no longer core team members. Gauvain has been committing to OpenStack manuals since well before my time, and has been an invaluable resource for many people (including myself!) over the years. He is currently working on some new projects, but we hope to still see him around from time to time. Atsushi-san joined the core team last year, and during that time has proven an extremely effective reviewer. He is still very busy on OpenStack, with an increased focus on cross-project tasks, so we will be sure to still see him around. I wish you well on your endeavours! I thank you both for your commitment to being core team members, and for all your contributions. We are better because of your effort. == Speciality Team Reports == '''HA Guide: Andrew Beekhof''' Organizing a HA meetup at summit Intention is get an update plan finalized shortly '''Install Tutorials: Lana Brindley''' Core Guide testing is underway! Check out progress and sign up here: https://wiki.openstack.org/wiki/Documentation/MitakaDocTesting Next meeting: 13 September August 0600UTC. '''Networking Guide: Edgar Magana''' No report this week. '''Security Guide: Nathaniel Dillon''' No report this week. '''User Guides: Joseph Robinson''' No report this week. '''Ops Guide: Shilla Saebi, Darren Chan''' No report this week. '''API Guide: Anne Gentle''' Working on an article for Super User describing the switchover in API guide sources to project repos and the new navigation. '''Config/CLI Ref: Tomoyuki Kato''' Consolidating the OSC command reference into the OSC specific doc. '''Training labs: Pranav Salunke, Roger Luethi''' No report this week. '''Training Guides: Matjaz Pancur''' Finished first day of our virtual sprint series (6 Sep): Common items: https://etherpad.openstack.org/p/upstream-uni-common-items (coordinated by Ildiko Vancsa, ildikov), Code contribution: https://etherpad.openstack.org/p/upstream-uni-code-contribution (coordinated by Kendall Nelson, diablo_rojo) Next virtual sprint dates: 12,13 and 16 September (https://wiki.openstack.org/wiki/VirtualSprints#Upstream_training_Sprint) '''Hypervisor Tuning Guide: Blair Bethwaite No report this week. '''UX/UI Guidelines: Michael Tullis, Rodrigo Caballero''' No report this week. == Doc team meeting == Next meetings: The APAC meeting was held this week, you can read the minutes here: https://wiki.openstack.org/wiki/Documentation/MeetingLogs#2016-09-07 Next meetings: US: Wednesday 14 September, 19:00 UTC APAC: Wednesday 21 September, 00:30 UTC Please go ahead and add any agenda items to the meeting page here: https://wiki.openstack.org/wiki/Meetings/DocTeamMeeting#Agenda_for_next_meeting -- Keep on doc'ing! Lana https://wiki.openstack.org/wiki/Documentation/WhatsUpDoc#9_September_2016 -- Lana Brindley Technical Writer Rackspace Cloud Builders Australia http://lanabrindley.com signature.asc Description: OpenPGP digital 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] [all] Timeframe for future elections & "Release stewards"
On 08/09/16 04:46, Matt Riedemann wrote: > On 9/7/2016 11:33 AM, Jim Rollenhagen wrote: >> >> I like this. As someone that has been PTL for multiple cycles, it is >> incredibly stressful trying to finish the release, start planning for the >> next one, manage summit planning, etc. I'd love to have someone >> designated to manage the release-specific bits of the project, while >> PTLs can worry about the longer-term vision of the project and the >> day-to-day management. >> >> Thanks for writing this up, Thierry. :) >> >> // jim >> > > I don't really see how managing the release-specific bits of the project as a > 'release steward' is different from a release cross-project liaison. Nova has > a release CPL (really more than one probably informally). > > I do think it's a bit weird that I've already slotted the Ocata design summit > rooms for Nova when someone else could be PTL, but I don't think what I'd > reserve would be drastically different from someone else in Nova, this is why > we have trust relationships and talk about stuff as a team. There was a lot > of overlap from Michael to John and from John to myself and we've shared > responsibilities during those transitions. > > The release steward concept just seems like unnecessarily complexity and > formality to me, but that's just my opinion. Things might work differently in > other projects. > Although I appreciate that my project is probably a bit different to many of the others (horizontal vs vertical, etc), I much prefer this method of overlapping the PTL changeover a little more instead of appointing form stewards. In docs, we've started assigning two release managers about a month before release time. They work with the PTL and other core team members to make sure the release happens smoothly, which allows the PTL the luxury of knowing there's eyes on all those small pieces that need to happen to get the release out while they get on with Summit prep. This means that having a formal release steward would just mean we appoint that person earlier in the cycle, so there's no real change for us in Thierry's proposal. We did this for a lot of reasons, at least some of which are about training people to understand the project on a deeper level (and thus create a leadership pipeline, of sorts). Having the PTL changeover time increase would have helped greatly during the time I was taking over as PTL from Anne. Like I said, docs is a little different, we have very little PTL-churn, which means that changeover process is a lot more complicated and involves a lot more information exchange than other projects that regularly change PTLs, I think. So I think this would be good for us, but accept that it might not work so well for other projects. Lana -- Lana Brindley Technical Writer Rackspace Cloud Builders Australia http://lanabrindley.com signature.asc Description: OpenPGP digital 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
[openstack-dev] What's Up, Doc? 2 September
Hi everyone, We have five weeks left until the Newton release goes out, so this week has been all about getting started on testing the Install Guide. We now have beta releases for all our distros, so thanks to our lovely package maintainers for getting back to me so quickly! We can still use more testers, though, all you need to do is sign up on the wiki page and start testing: https://wiki.openstack.org/wiki/Documentation/NewtonDocTesting This week Andreas, Brian, Olga, and I will be meeting with our new release managers Olena and Alex, to make sure they're up to speed. Don't forget that you can contact any of us (or just send mail to the docs mailing list) if you have any questions about the Newton docs release. == Progress towards Newton == 33 days to go! Bugs closed so far: 407 Release managers: Olena Logvinova and Alexandra Settle Install Guide testing is being tracked here: https://wiki.openstack.org/wiki/Documentation/NewtonDocTesting == The Road to Barcelona == * If there's something you want to make sure we discuss at Summit, please put your ideas here: https://etherpad.openstack.org/p/Ocata-DocsSessions When we get our room allocations, I'll organise it into a schedule. * Talk acceptances have gone out, congratulations to everyone who got something accepted! * If you require a visa invitation letter to travel to Spain, then you need to fill out the form here: https://www.openstack.org/summit/barcelona-2016/travel/#visa == Docs Tools == There is a lot of cleanup happening on the docs site right now, so you might see some old and unloved content disappear. If you notice anything strange, please let Andreas or the docs mailing list know so we can get it straightened out. == Speciality Team Reports == '''HA Guide: Andrew Beekhof''' No report this week. '''Install Tutorials: Lana Brindley''' Core Guide testing is underway! Check out progress and sign up here: https://wiki.openstack.org/wiki/Documentation/MitakaDocTesting Next meeting: 13 September August 0600UTC. '''Networking Guide: Edgar Magana''' No report this week. '''Security Guide: Nathaniel Dillon''' No report this week. '''User Guides: Joseph Robinson''' No report this week. '''Ops Guide: Shilla Saebi, Darren Chan''' No meeting last week in light of the ops mid cycle and OpenStack East conference Updating use cases chapter in Arch Guide Looking for more enterprise troubleshooting docs to push upstream for the ops guide '''API Guide: Anne Gentle''' New landing page for a collection of all API Reference docs and Guides in one place: https://review.openstack.org/#/c/361480/ Improvements to the sidebar link collection: https://review.openstack.org/#/c/362436/ '''Config/CLI Ref: Tomoyuki Kato''' Updated some CLI reference. Closed some bugs for Config Reference. '''Training labs: Pranav Salunke, Roger Luethi''' No report this week. '''Training Guides: Matjaz Pancur''' No report this week. '''Hypervisor Tuning Guide: Blair Bethwaite No report this week. '''UX/UI Guidelines: Michael Tullis, Rodrigo Caballero''' No report this week. == Site Stats == For the month of August, we had a 6% increase in traffic over July. == Doc team meeting == Next meetings: The US meeting was held this week, you can read the minutes here: https://wiki.openstack.org/wiki/Documentation/MeetingLogs#2016-08-31 Next meetings: APAC: Wednesday 7 September, 00:30 UTC US: Wednesday 14 September, 19:00 UTC Please go ahead and add any agenda items to the meeting page here: https://wiki.openstack.org/wiki/Meetings/DocTeamMeeting#Agenda_for_next_meeting -- Keep on doc'ing! Lana https://wiki.openstack.org/wiki/Documentation/WhatsUpDoc#2_September_2016 -- Lana Brindley Technical Writer Rackspace Cloud Builders Australia http://lanabrindley.com signature.asc Description: OpenPGP digital 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
[openstack-dev] What's Up, Doc? 26 August
Hi everyone, This week marks six weeks left to the Newton release, so I've been busy getting everything prepared. We're now ready to start testing the core Installation Tutorial, so check out the wiki and get signed up: https://wiki.openstack.org/wiki/Documentation/NewtonDocTesting#Testers We've also selected two new release managers to assist with this release, please welcome Olena and Alex! More on those topics in this newsletter. == Progress towards Newton == 40 days to go! Bugs closed so far: 387 Release planning: https://etherpad.openstack.org/p/NewtonRelease == Release Managers == There was an overwhelming response to my request for release managers, which was very cool! The first two responders were Olena Logvinova <ologvin...@mirantis.com> and Alexandra Settle <alexandra.set...@rackspace.com>, so please welcome them to the release team. Their main role during this process is to make sure that all the tasks we have to complete get done accurately and on schedule. It's an important job, and we're really glad to have you both on board. == Install Tutorial Testing == Install Tutorial testing is just about ready to kick off. If you're interested in helping, make sure you've added your name on to the list on our testing wiki page: https://wiki.openstack.org/wiki/Documentation/NewtonDocTesting (if you don't have wiki access, just email me directly and I'll add you in). Thanks to our package maintainers, we now have b2 pre-release packages ready for Ubuntu and Debian, so those are ready to be tested. == Docs Tools == I'm very pleased to announce that we have now removed DocBook from our build tools. The end of an era! Thanks to Anne, Andreas, and David Cramer for keeping this project alive for so long, and eventually seeing it come to fruition. Version 1.5.0 of openstackdoccstheme was released this week. In other tools news, there are plans afoot to move developer.openstack.org and docs.openstack.org away from Rackspace Cloudsites, and on to pages that OpenStack Infra control. This has been on the proverbial backburner for a long time, but the Infra team is now in a position to make it happen. You can read and comment on the Infra spec here: https://review.openstack.org/#/c/276482/ == Speciality Team Reports == '''HA Guide: Andrew Beekhof''' No report this week. '''Install Tutorials: Lana Brindley''' Core Guide testing is underway! Check out progress and sign up here: https://wiki.openstack.org/wiki/Documentation/MitakaDocTesting Next meeting: 30 August 0600UTC. '''Networking Guide: Edgar Magana''' Attending the OpenStack East in NYC. No report this week. '''Security Guide: Nathaniel Dillon''' No report this week. '''User Guides: Joseph Robinson''' No report this week. '''Ops Guide: Shilla Saebi, Darren Chan''' No report this week. '''API Guide: Anne Gentle''' Releasing openstackdocstheme with new sidebar and integration with os-api-ref Sphinx Extension. Many thanks to Karen Bradshaw, Sean Dague, Graham Hayes, Andreas Jaeger (and anyone I may have missed!) for their tireless efforts on this release. WOW. '''Config/CLI Ref: Tomoyuki Kato''' Merged some patches, updated a few CLI reference, nothing special. '''Training labs: Pranav Salunke, Roger Luethi''' Some minor changes, backports of features. The parser is almost done. https://github.com/dguitarbite/rst2bash Updated the openstack-manuals, install-guides with the new syntax which is parser friendly. I should start sending the required patches to manuals repo. soon after finalizing the syntax.. https://github.com/dguitarbite/openstack-manuals/commit/c9e7e1bb2c7269f02a757768dd2dd309fa2233ac '''Training Guides: Matjaz Pancur''' Upstream training improvement (https://etherpad.openstack.org/p/upstream-university-improvements). Please consider participating in the Remote content sprint (proposed timeframe: first half of September, see etherpad for details). '''Hypervisor Tuning Guide: Blair Bethwaite No report this week. '''UX/UI Guidelines: Michael Tullis, Rodrigo Caballero''' No report this week. == Site Stats == Keystone and Ceph are this week's most popular search terms. == Doc team meeting == Next meetings: The APAC meeting was held this week, you can read the minutes here: https://wiki.openstack.org/wiki/Documentation/MeetingLogs#2016-08-24 Next meetings: US: Wednesday 31 August, 19:00 UTC APAC: Wednesday 7 September, 00:30 UTC Please go ahead and add any agenda items to the meeting page here: https://wiki.openstack.org/wiki/Meetings/DocTeamMeeting#Agenda_for_next_meeting -- Keep on doc'ing! Lana https://wiki.openstack.org/wiki/Documentation/WhatsUpDoc#26_August_2016 -- Lana Brindley Technical Writer Rackspace Cloud Builders Australia http://lanabrindley.com signature.asc Description: OpenPGP digital signature __ OpenStack Development Mailing List (not for usage questions) Unsubscribe: o
[openstack-dev] What's Up, Doc? 19 August
Hi everyone, Watch out, Install Guide testing season is about to begin! If you're a package maintainer, cross-project liaison, or just a helpful testing regular, look out for an email from me real soon now! In the meantime, keep hitting those bugs, and letting us know if you spot any problems in the guide. == Progress towards Newton == 47 days to go! Bugs closed so far: 371 Newton deliverables: https://wiki.openstack.org/wiki/Documentation/NewtonDeliverables Feel free to add more detail and cross things off as they are achieved throughout the release. == Speciality Team Reports == '''HA Guide: Andrew Beekhof''' Some reviews, nothing interesting '''Install Tutorials: Lana Brindley''' Core Guide testing to kick off Real Soon Now (tm). Next meeting: 30 August 0600UTC. '''Networking Guide: Edgar Magana''' No report this week. '''Security Guide: Nathaniel Dillon''' No report this week. '''User Guides: Joseph Robinson''' No report this week. '''Ops Guide: Shilla Saebi, Darren Chan''' Reorganized monitoring content in the Ops Guide Migrating ops, legal, and security content in the Arch Guide Working on use cases chapter and design chapter in the Arch Guide '''API Guide: Anne Gentle''' No report this week. '''Config/CLI Ref: Tomoyuki Kato''' A few cleanups are under going. Updated some client references. '''Training labs: Pranav Salunke, Roger Luethi''' No report this week. '''Training Guides: Matjaz Pancur''' No report this week. '''Hypervisor Tuning Guide: Blair Bethwaite No report this week. '''UX/UI Guidelines: Michael Tullis, Rodrigo Caballero''' No report this week. == Site Stats == Just under 90,000 sessions on the docs site this week. == Doc team meeting == Next meetings: The US meeting failed to make quorum this week. We're seeing this a lot recently, is there still a need for a regular docs meeting? Next meetings: APAC: Wednesday 24 August, 00:30 UTC US: Wednesday 31 August, 19:00 UTC Please go ahead and add any agenda items to the meeting page here: https://wiki.openstack.org/wiki/Meetings/DocTeamMeeting#Agenda_for_next_meeting -- Keep on doc'ing! Lana https://wiki.openstack.org/wiki/Documentation/WhatsUpDoc#19_August_2016 -- Lana Brindley Technical Writer Rackspace Cloud Builders Australia http://lanabrindley.com signature.asc Description: OpenPGP digital 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] What's Up, Doc? 19 August (Correction)
On 19/08/16 14:59, Lana Brindley wrote: > > == Doc team meeting == > > Next meetings: > > The US meeting failed to make quorum this week. We're seeing this a lot > recently, is there still a need for a regular docs meeting? > A correction: US meeting *did* go ahead this week, minutes are here: https://wiki.openstack.org/wiki/Documentation/MeetingLogs#2016-08-17 Please excuse me while I try to work out how to use eavesdrop. > Next meetings: > APAC: Wednesday 24 August, 00:30 UTC > US: Wednesday 31 August, 19:00 UTC > > Please go ahead and add any agenda items to the meeting page here: > https://wiki.openstack.org/wiki/Meetings/DocTeamMeeting#Agenda_for_next_meeting > > -- > > Keep on doc'ing! > > Lana > > https://wiki.openstack.org/wiki/Documentation/WhatsUpDoc#19_August_2016 > -- Lana Brindley Technical Writer Rackspace Cloud Builders Australia http://lanabrindley.com signature.asc Description: OpenPGP digital 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
[openstack-dev] What's Up, Doc? 12 August
Hi everyone, I have been struck down with flu yet again this week, so a quiet one from me (I'll be glad when winter is over, let me tell you!). Anne, however, has been kicking it out of the park with her work on the API docs; I suggest you take a look at the update she sent to the mailing lists the other day to catch up: http://lists.openstack.org/pipermail/openstack-dev/2016-August/101380.html == Progress towards Newton == 54 days to go! Bugs closed so far: 365 Newton deliverables: https://wiki.openstack.org/wiki/Documentation/NewtonDeliverables Feel free to add more detail and cross things off as they are achieved throughout the release. == Speciality Team Reports == '''HA Guide: Andrew Beekhof''' No report this week. '''Install Tutorials: Lana Brindley''' Next meeting: 16 August 0600UTC '''Networking Guide: Edgar Magana''' No report this week. '''Security Guide: Nathaniel Dillon''' Bug hunt continued, all contributions are welcome, grammatical and technical alike! Focusing on the last half of the SecurityGuide, and the 'freshness' of code examples Threat analysis documentation and templates added '''User Guides: Joseph Robinson''' The Consistency and Editing patch is ready to merge, and just needs more reviews https://review.openstack.org/#/c/347641/ . Some pages in the User Guides are resulting in 404s (dashboard manage shares for example), and this bug is tracking the changes https://bugs.launchpad.net/openstack-manuals/+bug/1611792 Thanks to Maria for taking on the file name changes to the User Guide, and Anne for also patching the Admin Guide file names! '''Ops Guide: Shilla Saebi, Darren Chan''' Working on storage, networking, and compute sections in the Arch Guide. Arch Guide working group proposed a series of short sprints, working in pairs as SME/writer. Dates TBD Waiting on enterprise ops documentation to migrate to the Ops Guide. '''API Guide: Anne Gentle''' Ceilometer migrated content has landed! \o/ https://review.openstack.org/334028 Many thanks to Khushbu Parakh for sticking with it, and to Julien Danjou and Gordon Chung for accepting the (rather outdated) migrated content and taking responsiblity for it from now on. Working on a template for http-status.yaml file that teams can use for new pretty HTTP Status code tables that just landed last week. https://review.openstack.org/#/c/351835/ Ever closer to landing the API reference navigation. https://review.openstack.org/#/c/329508/ Refer to status report on -dev and -docs mailing lists: http://lists.openstack.org/pipermail/openstack-dev/2016-August/101380.html '''Config/CLI Ref: Tomoyuki Kato''' Closed a few bugs with mitaka backport. '''Training labs: Pranav Salunke, Roger Luethi''' No report this week. '''Training Guides: Matjaz Pancur''' Updating Upstream training for the next OpenStack Summit (https://etherpad.openstack.org/p/upstream-university-improvements) Next meeting: Monday 15 August 1700 UTC in #openstack-meeting '''Hypervisor Tuning Guide: Blair Bethwaite No report this week. '''UX/UI Guidelines: Michael Tullis, Rodrigo Caballero''' No report this week. == Site Stats == This week, 385 visitors came to the docs site from Stack Overflow, 423 visitors came via searching on duckduckgo, and 508 came from ask.openstack.org. == Doc team meeting == Next meetings: The APAC meeting failed to make quorum this week, but thanks to Darren for trying anyway :) Next meetings: US: Wednesday 17 August, 19:00 UTC APAC: Wednesday 24 August, 00:30 UTC Please go ahead and add any agenda items to the meeting page here: https://wiki.openstack.org/wiki/Meetings/DocTeamMeeting#Agenda_for_next_meeting -- Keep on doc'ing! Lana https://wiki.openstack.org/wiki/Documentation/WhatsUpDoc#12_August_2016 -- Lana Brindley Technical Writer Rackspace Cloud Builders Australia http://lanabrindley.com signature.asc Description: OpenPGP digital 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
[openstack-dev] What's Up, Doc? 29 July
Hi everyone, A fairly quiet week this week, as I've been gradually working my way through old bugs. We're now only ten weeks out from release, so I've also been trying to tidy up some loose ends around the Contributor Guide. We have a couple of specs out for review right now, so if you're looking for some docs work to pick up, try checking these out: https://review.openstack.org/#/q/status:open+project:openstack/docs-specs,n,z == Progress towards Newton == 68 days to go! Bugs closed so far: 339 Newton deliverables: https://wiki.openstack.org/wiki/Documentation/NewtonDeliverables Feel free to add more detail and cross things off as they are achieved throughout the release. == Speciality Team Reports == '''HA Guide: Andrew Beekhof''' Informal discussions about appropriate contents and structure '''Install Tutorials: Lana Brindley''' Next meeting: 2 August 0600 UTC '''Networking Guide: Edgar Magana''' Guide re-organization patch has been merged: https://review.openstack.org/#/c/345110/ '''Security Guide: Nathaniel Dillon''' Performing full read-through and bug hunt Opened 5 new bugs Currently looking at Neutron chapter Incoming addition on rate-limiting and anti-DDoS (framework merged tonight (thanks Kato!) and additional details coming) '''User Guides: Joseph Robinson''' No report this week. '''Ops Guide: Shilla Saebi, Darren Chan''' Weekly Arch Guide working group meeting on Wednesday 20:00 UTC in progress. Currently drafting the Design chapter and reusing existing content. Working on getting more enterprise docs uploaded and pushed upstream for ops guide '''API Guide: Anne Gentle''' First App tutorial for the Shade SDK now moving out of draft state. Way to go Marcela Bonell and infra people who make this SDK possible. Thank you to Kato Tomoyuki for deletions of the Image and Networking WADL files in api-site. This ongoing dedication and cleanup is super valuable and much appreciated. '''Config/CLI Ref: Tomoyuki Kato''' Reflecting comments from Stackers. Closed a few bugs for Configuration Reference. Working on the common configurations. '''Training labs: Pranav Salunke, Roger Luethi''' No report this week. '''Training Guides: Matjaz Pancur''' No report this week. '''Hypervisor Tuning Guide: Blair Bethwaite No report this week. '''UX/UI Guidelines: Michael Tullis, Rodrigo Caballero''' No report this week. == Site Stats == Just under 55% of our mobile visitors are using an Android operating system to access the site, while just under 40% of our mobile visitors are using iOS. A statistically insignificant 0.07% are still using their Blackberries ... == Doc team meeting == Next meetings: The APAC meeting was held this week, you can read the minutes here: https://wiki.openstack.org/wiki/Documentation/MeetingLogs#2016-07-27 Next meetings: US: Wednesday 3 August, 19:00 UTC APAC: Wednesday 10 August, 00:30 UTC Please go ahead and add any agenda items to the meeting page here: https://wiki.openstack.org/wiki/Meetings/DocTeamMeeting#Agenda_for_next_meeting -- Keep on doc'ing! Lana https://wiki.openstack.org/wiki/Documentation/WhatsUpDoc#29_July_2016 -- Lana Brindley Technical Writer Rackspace Cloud Builders Australia http://lanabrindley.com signature.asc Description: OpenPGP digital 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
[openstack-dev] What's Up, Doc? 22 July
Hi everyone, As many of you would have noticed from the email onslaught, I've been working on some Launchpad housekeeping this week. The blueprints are all tidied up now, and I intend to start on the bug list next week, so keep those email filters handy ;) I'd also like to point out the hard work Andreas has been putting in to evaluate moving our docs jobs to Ubuntu Xenial. If you notice any weirdness, please let Andreas know. == Progress towards Newton == 75 days to go! Bugs closed so far: 315 Newton deliverables: https://wiki.openstack.org/wiki/Documentation/NewtonDeliverables Feel free to add more detail and cross things off as they are achieved throughout the release. == Speciality Team Reports == '''HA Guide: Andrew Beekhof''' Got drafted (pun intended) Started figuring out the current status and direction '''Install Tutorials: Lana Brindley''' Next meeting: 2 August 0600 UTC '''Networking Guide: Edgar Magana''' No report this week. '''Security Guide: Nathaniel Dillon''' No report this week. '''User Guides: Joseph Robinson''' No report this week. '''Ops Guide: Shilla Saebi, Darren Chan''' Started a weekly Arch Guide working group meeting on Wednesday 20:00 UTC. Currently drafting the Design chapter and reusing existing content. '''API Guide: Anne Gentle''' Sent email to -dev and -docs list to determine next steps for releasing openstackdocstheme and os-api-ref sphinx extension so we can get the better theming output: http://lists.openstack.org/pipermail/openstack-dev/2016-July/099373.html Released 1.4.0 of openstackdocstheme in preparation for August (hopefully) readiness of theme/extension for unifying API docs navigation. Completed updated of governance/reference/projects.yaml to indicate contributor and api docs URLs. Found that three projects have not completed migration (trove, telemetry/ceilometer, ) and found that nn projects don't use the openstackdocstheme and os-api-ref extension and then won't be included in a unified navigation solution for all OpenStack APIs. '''Config/CLI Ref: Tomoyuki Kato''' Adding Clustering service configuration options. Fixed some bugs. Updated a few CLI reference. Added python-watcherclient. '''Training labs: Pranav Salunke, Roger Luethi''' No report this week. '''Training Guides: Matjaz Pancur''' No report this week. '''Hypervisor Tuning Guide: Blair Bethwaite No report this week. '''UX/UI Guidelines: Michael Tullis, Rodrigo Caballero''' All five personas are up for review on Gerrit. https://review.openstack.org/#/c/326662/ Further improvements are planned for after the basic information is merged. == HA Guide Speciality Team Update == Bogdan Dobrelya is stepping down from leading the HA Guide Speciality Team, and I would like to thank him for his hard work. I'd like to welcome Andrew Beekhof to the role, and wish him all the best. If you're interesting in helping out on the HA Guide, please let Andrew or me know and we'll get you started. == Site Stats == While 70% of our site traffic comes through Google, just under 5% comes through Baidu, beating Bing on just 1.45%. == Doc team meeting == Next meetings: The US meeting was held this week, you can read the minutes here: https://wiki.openstack.org/wiki/Documentation/MeetingLogs#2016-07-20 Next meetings: APAC: Wednesday 27 July, 00:30 UTC US: Wednesday 3 August, 19:00 UTC Please go ahead and add any agenda items to the meeting page here: https://wiki.openstack.org/wiki/Meetings/DocTeamMeeting#Agenda_for_next_meeting -- Keep on doc'ing! Lana https://wiki.openstack.org/wiki/Documentation/WhatsUpDoc#22_July_2016 -- Lana Brindley Technical Writer Rackspace Cloud Builders Australia http://lanabrindley.com signature.asc Description: OpenPGP digital 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
[openstack-dev] What's Up, Doc? 15 July
Hi everyone, CFP for the Barcelona Summit closed this week, so I've been caught up in the flurry of talk submissions. I hope you got yours in on time! We have more Installation Tutorials going up all the time, with Swift up and Designate now in progress. I'd also like to remind you all that we have instructions for creating your team's Install Tutorial in our Contributor Guide here: http://docs.openstack.org/contributor-guide/project-install-guide.html We'd love to get your feedback on that content! == Progress towards Newton == 82 days to go! Bugs closed so far: 280 Newton deliverables: https://wiki.openstack.org/wiki/Documentation/NewtonDeliverables Feel free to add more detail and cross things off as they are achieved throughout the release. The CFP for Barcelona is now closed. Best of luck to everyone who submitted a talk :) == Speciality Team Reports == '''HA Guide: Bogdan Dobrelya''' No report this week. '''Install Tutorials: Lana Brindley''' Continued to publish new guides, Swift is now up, Designate is on review. Submitted Summit talk on this topic. Don't miss our instructions for creating a new Install Tutorial: http://docs.openstack.org/contributor-guide/project-install-guide.html Next meeting: 19 July 0600 UTC '''Networking Guide: Edgar Magana''' No meeting this week. '''Security Guide: Nathaniel Dillon''' No report this week. '''User Guides: Joseph Robinson''' No report this week. '''Ops Guide: Shilla Saebi''' OpenStack ops guide reorg in progress & documented here: https://etherpad.openstack.org/p/ops-guide-reorg Added enterprise docs troubleshooting information to the Ops Guide '''API Guide: Anne Gentle''' Keystone API sprint this week, details are here: https://etherpad.openstack.org/p/keystone-api-sprint Lance Bragstad is on FIRE! Review these api-ref patchsets in progress: https://review.openstack.org/#/q/status:open+file:api-ref Working on a plan for how to merge HTTP Status Code tables and Graham Hayes's patch to use the openstackdocstheme and Karen Bradshaw's overall API navigation in time for release, stay tuned. '''Config/CLI Ref: Tomoyuki Kato''' Got feedbacks from Dolph Matthews, thank you! Closed a few bugs. Updated some CLI reference. '''Training labs: Pranav Salunke, Roger Luethi''' Many minor improvements to training-labs library scripts Finalizing PXE feature, still more work is required but the current patch should be in a state to be merged soon. Finalizing parser POC to parse install-guides to BASH for testing install guides and also auto-creation of guest side scripts for training-labs '''Training Guides: Matjaz Pancur''' Removed unused images for Training guides, improvements on Getting Started (core and optional services, link updates). '''Hypervisor Tuning Guide: Blair Bethwaite No report this week. '''UX/UI Guidelines: Michael Tullis, Rodrigo Caballero''' No report this week. == Core Team Review == Regretfully, Diane Fleming is no longer a core team member. I'd like to thank Diane for all her contributions to our team. She's been a powerhouse core team member since well before I did my very first OpenStack patch, and I think it's fair to say that many of us wouldn't be here without Diane's support and guidance. == Site Stats == The number of people browsing the site using Opera has dropped by 5% over the past 30 days, but nearly 20% more people are using Edge (which I'm told is the new Windows browser that's replacing IE). Oddly, IE users have increased slightly as well, though, by 7%. Are people abandoning their Macs?! == Doc team meeting == Next meetings: The APAC meeting was held this week (big thanks to Joseph for chairing that meeting in my absence!), you can read the minutes here: https://wiki.openstack.org/wiki/Documentation/MeetingLogs#2016-07-13 Next meetings: US: Wednesday 20 July, 19:00 UTC APAC: Wednesday 27 July, 00:30 UTC Please go ahead and add any agenda items to the meeting page here: https://wiki.openstack.org/wiki/Meetings/DocTeamMeeting#Agenda_for_next_meeting -- Keep on doc'ing! Lana https://wiki.openstack.org/wiki/Documentation/WhatsUpDoc#15_July_2016 -- Lana Brindley Technical Writer Rackspace Cloud Builders Australia http://lanabrindley.com signature.asc Description: OpenPGP digital 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] [Murano][user-guide][docs] Add section 'Murano applications guide' to the End User Guide
Hi Serg! I've cc'd Joseph into this mail, to make sure he sees it. Joseph looks after the User Guides speciality team within docs. To answer your question, a spec really is the best way to start with this content, it will probably also help you pick up some interested helpers. Once that's approved, go right ahead and start with patches :) L On 13/07/16 03:14, Sergey Slypushenko wrote: > Hi, folks! > > I'm working on user guide about developing and using custom Murano > applications. As far as I'm concerned End User Guide [1] would be a perfect > fit for this document. Mainly because, it demonstarates one more way to > regular cloud users, how they can consume services provided by OpenStack > cloud. > > Looking through latest version of End User Guide, I surprisingly found that > there are no references to Murano project in it. So, I submitted this > patchset [2]. It suppose to be a placeholder to put Murano related user > guides in it. For the very begging, I just make reference on existed docs, > like it is done for Heat object templates [3] now. We already have been > working on more content for this section. So, what is proper way to move > forward? I see, some options here: > > * Submit a spec from this activity to docs-specs > * Prepare whole Murano user guide and send it in a single patchset > * Land initial patchset and continue work on providing more content > > Personally, I'd prefer the latest option, but i'm not very familiar with > recognized flow. So, what do you think, folks? > > Best Regards, > Serg Slipushenko > > [1] http://docs.openstack.org/user-guide/ > [2] https://review.openstack.org/#/c/340474/ > [3] http://docs.openstack.org/user-guide/hot.html > > > __ > 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 > -- Lana Brindley Technical Writer Rackspace Cloud Builders Australia http://lanabrindley.com signature.asc Description: OpenPGP digital 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] The future of OpenStack documentation
On 12/07/16 09:45, Matt Kassawara wrote: > Inline... > > On Sun, Jul 10, 2016 at 5:22 PM, Lana Brindley <openst...@lanabrindley.com > <mailto:openst...@lanabrindley.com>> wrote: > > On 09/07/16 07:02, Matt Kassawara wrote: > > Currently, OpenStack provides central documentation (primarily in the > openstack-manuals repository) for operators and users. The single location > and consistent structure eases audiences of various technical expertise into > OpenStack, typically operators and users rather than developers. Although I'm > not a fan of the word "product", increasingly less technical audiences are > learning about OpenStack and tend to compare it with other cloud > infrastructure products. Such audiences expect a coherent, relatively mature > product to easily evaluate, usually via proof-of-concept. Upon deciding to > implement OpenStack, the central documentation attempts to gracefully lead > them toward a production deployment that meets or exceeds requirements and > expectations. > > > > However, since I began contributing to OpenStack documentation around > the Havana release, I am seeing many projects, particularly core projects, > trending toward more independence from other projects including central > documentation. For operator and user documentation, a couple of projects > contribute to the central documentation repository, some projects contribute > to their own repositories, and an alarmingly large number of projects simply > do not contribute such documentation and assume that all audiences involve > developers. These differences lead to an increasingly negative overall > experience for the audiences that OpenStack needs to increase adoption/growth > and maintain the existing deployment base. > > bI know the UX team have been working on getting some data around this, > but I'd be interested to know what data you have. The User Survey highlighted > that, while OpenStack itself is difficult to understand, most people are > pretty happy with the current state of the documentation. Also, of the core > projects that users interact with, we have a good relationship with the Cross > Project Liaisons and PTLs, and are consistently working with them to keep > docs up to date. Docs are very much a living thing, especially in a situation > like ours, where there are a lot of components all at different maturity > levels. Is there something specific you feel we're dropping a ball on? > > > Most of my data involves a combination of observations from providing support > in #openstack (and some other channels) on IRC, mailing list posts, bug > reports, and attempting to use (or reference) the existing documentation. > > I think is falling into the 'gut feel' region as far as data goes. As I said, we're working on a research project to gather actual data about this, so I'd like to base decisions on that more than on a small sample size. > > > > > As a contributor to central documentation and one or more other > projects including neutron, I see the problems from both sides and don't > particularly blame either party for them. Some politics, some technical, some > a lack of resources, and some just a general misunderstanding about > documentation. However, I think we need to develop a solution that works for > both parties and ultimately benefits our audiences. > > I don't think I fully understand the problem you're trying to solve here, > yet, which makes it difficult to determine a solution. > > > I'm trying to solve the problem of the central documentation content falling > behind the development curve of OpenStack. The documentation team can't keep > up with the exponential growth of OpenStack and most projects don't > contribute sufficient documentation for the audiences that the central > documentation serves. The user guide came to mind today when I attempted to > link to it for OpenStack client commands and found out it doesn't even > mention the OSC. How do we get users to adopt the OSC if the documentation > doesn't cover it? > Documentation falling behind development on a project such as this is not terribly surprising, or unexpected. As you know, we've changed the Install guide project to try and address the big tent growth issue, but we really need to sit back and wait until that's been implemented before we can bubble those changes out to the rest of the docs project. I know this is a favourite bugbear of yours, and for the record I agree with you, but we also need to be realistic about what we can achieve. We've already achieved a large amount of positive progress in this direction during the Newton release, and I'm sure we'll continue to innovate and
Re: [openstack-dev] The future of OpenStack documentation
Matt,
Can you please articulate the problem you're trying to solve?
As Andreas says, we had specific problems that needed to be solved for the
Install Guide and API docs, which is why they were done first.
Lana
On 12/07/16 08:26, Matt Kassawara wrote:
> Andreas,
>
> I consider the API documentation and installation guide rather complex for
> initial content to move to project repositories and evaluate the results.
> However, we're seeing rather strong adoption of moving API documentation
> which I think predicts adoption of moving operator/user documentation more
> than the installation guide. Regardless of outcome, the API documentation
> caters to a smaller audience with at least some knowledge of OpenStack and/or
> development experience, thus having less impact on adoption of OpenStack. On
> the other hand, the installation guide is extremely popular and caters to a
> larger audience with little (if any) prior knowledge of OpenStack that
> expects the procedures to work with minimal frustration. Victimizing this
> audience hinders adoption of OpenStack and may cast the wrong impression of
> moving content into project repositories.
>
> On Mon, Jul 11, 2016 at 3:52 PM, Michael Johnson <johnso...@gmail.com
> <mailto:johnso...@gmail.com>> wrote:
>
> I support putting infrastructure in place to allow the project
> documentation to be in the project's repository. We had problems in
> the Mitaka release with documentation getting deleted without the
> project team knowing it was happening until users were asking us where
> the documentation was located.
>
> Having it in the repository makes it easier to review that the
> required documentation updates are being made and gives the project
> team visibility to changes in the documentation.
>
> Michael
>
>
> On Sun, Jul 10, 2016 at 10:31 PM, Andreas Jaeger <a...@suse.com
> <mailto:a...@suse.com>> wrote:
> >
> > With Install Guide and API references, we had specific problems to
> > solve. Which ones do you see exactly with other guides?
> >
> > Also, before we discuss moving further documentation around, I'd like to
> > see first how the API references and Install guides work out and what we
> > need to improve there - before discussing next steps,
> >
> > Andreas
> > --
> > Andreas Jaeger aj@{suse.com <http://suse.com>,opensuse.org
> <http://opensuse.org>} Twitter/Identica: jaegerandi
> > SUSE LINUX GmbH, Maxfeldstr. 5, 90409 Nürnberg, Germany
> >GF: Felix Imendörffer, Jane Smithard, Graham Norton,
> >HRB 21284 (AG Nürnberg)
> > GPG fingerprint = 93A3 365E CE47 B889 DF7F FED1 389A 563C C272 A126
> >
> >
> >
> __
> > OpenStack Development Mailing List (not for usage questions)
> > Unsubscribe:
> openstack-dev-requ...@lists.openstack.org?subject:unsubscribe
> <http://openstack-dev-requ...@lists.openstack.org?subject:unsubscribe>
> > http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-dev
>
> __
> OpenStack Development Mailing List (not for usage questions)
> Unsubscribe:
> openstack-dev-requ...@lists.openstack.org?subject:unsubscribe
> <http://openstack-dev-requ...@lists.openstack.org?subject:unsubscribe>
> http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-dev
>
>
>
>
> __
> 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
>
--
Lana Brindley
Technical Writer
Rackspace Cloud Builders Australia
http://lanabrindley.com
signature.asc
Description: OpenPGP digital 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] The future of OpenStack documentation
On 09/07/16 07:02, Matt Kassawara wrote: > Currently, OpenStack provides central documentation (primarily in the > openstack-manuals repository) for operators and users. The single location > and consistent structure eases audiences of various technical expertise into > OpenStack, typically operators and users rather than developers. Although I'm > not a fan of the word "product", increasingly less technical audiences are > learning about OpenStack and tend to compare it with other cloud > infrastructure products. Such audiences expect a coherent, relatively mature > product to easily evaluate, usually via proof-of-concept. Upon deciding to > implement OpenStack, the central documentation attempts to gracefully lead > them toward a production deployment that meets or exceeds requirements and > expectations. > > However, since I began contributing to OpenStack documentation around the > Havana release, I am seeing many projects, particularly core projects, > trending toward more independence from other projects including central > documentation. For operator and user documentation, a couple of projects > contribute to the central documentation repository, some projects contribute > to their own repositories, and an alarmingly large number of projects simply > do not contribute such documentation and assume that all audiences involve > developers. These differences lead to an increasingly negative overall > experience for the audiences that OpenStack needs to increase adoption/growth > and maintain the existing deployment base. bI know the UX team have been working on getting some data around this, but I'd be interested to know what data you have. The User Survey highlighted that, while OpenStack itself is difficult to understand, most people are pretty happy with the current state of the documentation. Also, of the core projects that users interact with, we have a good relationship with the Cross Project Liaisons and PTLs, and are consistently working with them to keep docs up to date. Docs are very much a living thing, especially in a situation like ours, where there are a lot of components all at different maturity levels. Is there something specific you feel we're dropping a ball on? > > As a contributor to central documentation and one or more other projects > including neutron, I see the problems from both sides and don't particularly > blame either party for them. Some politics, some technical, some a lack of > resources, and some just a general misunderstanding about documentation. > However, I think we need to develop a solution that works for both parties > and ultimately benefits our audiences. I don't think I fully understand the problem you're trying to solve here, yet, which makes it difficult to determine a solution. > > One potential solution essentially involves moving operator and user > documentation into project repositories (similar to developer documentation) > and using infrastructure to coherently present it on docs.openstack.org > <http://docs.openstack.org/> which achieves the following goals: But I still don't understand what problem you're solving for here. Is the problem that developers aren't contributing to docs? That the docs are out of date? That users aren't finding the right docs? > > 1) Project developers can contribute documentation and code in the same > patch, thus avoiding two different review queues and reviewers with different > motivations and guidelines. > 2) Project developers can either work directly or via liaison with one or > more documentation team members to improve documentation components during > development or after merging technically accurate content. > 3) Rather than attempting to document all projects with little (if any) > assistance from those projects, the primary role of the documentation team > becomes managing overall organization/presentation of documentation and > assisting projects with their contributions. > We did something very similar with the Install Guide because it was the most efficient way to allow all big tent project teams to have an Install Guide on docs.o.o, while still providing a central point for users to go to find the content. I'm happy to consider doing this for other projects, but we need to wait until the new Install Guide is live for Newton, and we have some solid feedback on whether or not the project was a success. Right now, we're still implementing it. > We're seeing decent adoption of moving API documentation into project > repositories, so I want to initiate some discussion about moving additional > documentation (or other options) prior to mid-cycles (including ops) and the > next summit. We will definitely be doing a full retro on the Install Guide project in Barcelona, but g
[openstack-dev] What's Up, Doc? 8 July
Hi everyone, This week I'm pleased to report that the index page for the new Install Tutorials is up and running! We also had some lengthy discussions about the use of conditionalised formatting (with ``only``), so there were a few meaty topics to go through in the meeting this week. It's also been way too long since we last did a core team review, so that happened this week. I'd also like to remind you that the CFP for Barcelona is only open until mid next week, so get your proposals in soon! == Progress towards Newton == 89 days to go! Bugs closed so far: 256 I think 50 bugs in two weeks is something of a record! Thanks to all the bug smashers working hard this week :) Newton deliverables: https://wiki.openstack.org/wiki/Documentation/NewtonDeliverables Feel free to add more detail and cross things off as they are achieved throughout the release. The CFP for Barcelona is open now, until 13 July. If you want to brainstorm some documentation-related ideas, please get in touch! == Speciality Team Reports == '''HA Guide: Bogdan Dobrelya''' No report this week. '''Install Guide: Lana Brindley''' Index page is now up, needs some iteration to improve. Decided against using ``only`` for now (review after Newton), Manila patch to be updated. Next meeting: 19 July 0600 UTC '''Networking Guide: Edgar Magana''' No meeting this week. Keep trying to move documentation from other dispersed places to the networking guide. '''Security Guide: Nathaniel Dillon''' No report this week. '''User Guides: Joseph Robinson''' Adding the consistency notes to the work items wiki page. Team emails. '''Ops Guide: Shilla Saebi''' No report this week. '''API Guide: Anne Gentle''' Sign up on the etherpad to participate in a keystone Identity API sprint: https://etherpad.openstack.org/p/keystone-api-sprint New patch this week to migrate the ceilometer Telemetry API docs, please review: https://review.openstack.org/334028 Thank you Khushbu! Need another +2 from the swift team for their migration patch: https://review.openstack.org/#/c/312315/ Updated patch in the governance repo projects.yaml file to indicate both contributor docs URLs and API docs URLs: https://review.openstack.org/#/c/316396/ Consider a work in progress for URL completeness and accuracy, but please review for format. Responding to input about API versions and release versions. See http://lists.openstack.org/pipermail/openstack-docs/2016-July/008818.html '''Config/CLI Ref: Tomoyuki Kato''' Closed many bugs. Implementing common configuration sections for shared services and libraries. Updated a few clients reference, and added solum client. '''Training labs: Pranav Salunke, Roger Luethi''' No report this week. '''Training Guides: Matjaz Pancur''' No report this week. '''Hypervisor Tuning Guide: Blair Bethwaite No report this week. '''UX/UI Guidelines: Michael Tullis, Rodrigo Caballero''' Three out of the five personas have been created and are being reviewed. https://review.openstack.org/#/c/326662/ The last two personas will be added to the change within the week. It was suggested to add a checklist for developers to be able to identify the appropriate persona for their work. == Core Team Review == The core team have completed their review for July, and we would like to welcome Joseph Robinson to the openstack-doc-core team. Joseph has been leading the User Guides speciality team for some time now, and has been a docs-specs-core as part of that role. Welcome to the larger core team, Joseph, we're really pleased to have you aboard :) == Site Stats == 25% of our hits are coming from new (rather than returning) users. == Doc team meeting == Next meetings: The US meeting was held this week, you can read the minutes here: https://wiki.openstack.org/wiki/Documentation/MeetingLogs#2016-07-06 Next meetings: APAC: Wednesday 13 July, 00:30 UTC US: Wednesday 20 July, 19:00 UTC Please go ahead and add any agenda items to the meeting page here: https://wiki.openstack.org/wiki/Meetings/DocTeamMeeting#Agenda_for_next_meeting -- Keep on doc'ing! Lana https://wiki.openstack.org/wiki/Documentation/WhatsUpDoc#8_July_2016 -- Lana Brindley Technical Writer Rackspace Cloud Builders Australia http://lanabrindley.com signature.asc Description: OpenPGP digital 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
[openstack-dev] What's Up, Doc? 24 June 2016
Hi everyone, We're starting to see a real rush of projects publishing their Install Guides this week, which is really exciting! We're also working on getting the index page on docs.openstack.org up and running, so we should have that ready to go up by the time I'm writing this newsletter next week. Well done to all the docs people, and the cross-project liaisons who have been working hard to make this happen. It's great to see it all start to come together :) == Progress towards Newton == 103 days to go! Bugs closed so far: 207 Newton deliverables: https://wiki.openstack.org/wiki/Documentation/NewtonDeliverables Feel free to add more detail and cross things off as they are achieved throughout the release. Also, just a note that the CFP for Barcelona is open now, until 13 July. If you want to brainstorm some documentation-related ideas, please get in touch! == Speciality Team Reports == '''HA Guide: Bogdan Dobrelya''' No report this week. '''Install Guide: Lana Brindley''' Swift, Manila patches in progress. Petr is working on the index page: https://review.openstack.org/331704 Feedback requested! Next meeting: 5 July 0600 UTC '''Networking Guide: Edgar Magana''' No report this week. '''Security Guide: Nathaniel Dillon''' No report this week. '''User Guides: Joseph Robinson''' No report this week. '''Ops Guide: Shilla Saebi''' Team is currently reviewing enterprise ops documentation to incorporate into the Ops Guide. Ops tasks are documented here: https://etherpad.openstack.org/p/ops-arch-tasks OpenStack ops guide reorg in progress & documented here: https://etherpad.openstack.org/p/ops-guide-reorg Members of the ops guide team are joining ops meetings to find volunteers '''API Guide: Anne Gentle''' Progress ongoing on navigation for multiple OpenStack APIs: https://review.openstack.org/#/c/329508 Working on lists of project's API references that don't use RST+YAML framework: http://lists.openstack.org/pipermail/openstack-docs/2016-June/008775.html '''Config/CLI Ref: Tomoyuki Kato''' Got some comments for improvements from Brian Rosmaita, Hemanth Makkapati and Richard Jones. Thank you! Closed many bugs for Configuration Reference. Updated openstack, glance, neutron-sanity-check, and trove-manage CLI reference. '''Training labs: Pranav Salunke, Roger Luethi''' Webpage is looking good and also all the URL's point to the right link http://docs.openstack.org/training_labs/ Trying to finalize PXE support https://review.openstack.org/#/c/305991/ '''Training Guides: Matjaz Pancur''' Italian translation of the Upstream training Details about running a Lego session (https://review.openstack.org/#/c/325020/, https://review.openstack.org/#/c/330819/) '''Hypervisor Tuning Guide: Blair Bethwaite No report this week. '''UX/UI Guidelines: Michael Tullis, Rodrigo Caballero''' No report this week. == Site Stats == The top five search terms on the site so far during June: snapshot, cinder, nova, security group, quota == Doc team meeting == Next meetings: The US meeting was held this week, you can read the minutes here: https://wiki.openstack.org/wiki/Documentation/MeetingLogs#2016-06-22 Next meetings: APAC: Wednesday 29 June, 00:30 UTC US: Wednesday 6 July, 19:00 UTC Please go ahead and add any agenda items to the meeting page here: https://wiki.openstack.org/wiki/Meetings/DocTeamMeeting#Agenda_for_next_meeting -- Keep on doc'ing! Lana https://wiki.openstack.org/wiki/Documentation/WhatsUpDoc#24_June_2016 -- Lana Brindley Technical Writer Rackspace Cloud Builders Australia http://lanabrindley.com signature.asc Description: OpenPGP digital 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
[openstack-dev] What's Up, Doc? 17 June 2016
Hi everyone, This week I've very pleased to announce that we have our first project-specific Install Guide published! Petr Kovar got Heat over the line in first place, and it's looking great: http://docs.openstack.org/project-install-guide/orchestration/draft/index.html Well done Petr, and of course all the wonderful docs people who helped us get to this point. We're also expecting to see Trove published very soon. I've been using the lessons learned from these early projects to flesh out our instructions a little more, so it should be even easier for projects to get their Install Guides up and running. We still need to create the central index, but it's all starting to come together now. I'm also excited to announce that, for the very first time, we have a specific Ops Cross-Project Liaison. Please welcome Robert Starmer to the CPL family :) == Progress towards Newton == 110 days to go! Bugs closed so far: 185 Newton deliverables: https://wiki.openstack.org/wiki/Documentation/NewtonDeliverables Feel free to add more detail and cross things off as they are achieved throughout the release. Also, just a note that the CFP for Barcelona is open now, until 13 July. If you want to brainstorm some documentation-related ideas, please get in touch! == Speciality Team Reports == '''HA Guide: Bogdan Dobrelya''' No report this week. '''Install Guide: Lana Brindley''' Orchestration is done! Well done, Petr :) Working on updating instructions in the Contributor Guide. Instructions: http://docs.openstack.org/contributor-guide/project-install-guide.html Next meeting: Tue 21 June 0600 UTC '''Networking Guide: Edgar Magana''' No report this week. '''Security Guide: Nathaniel Dillon''' No report this week. '''User Guides: Joseph Robinson''' Began a consistency and IA plan, and held the US meeting. Emailing one new interested contributor. '''Ops Guide: Darren Chan''' Some architecture content moved from the Ops Guide to the draft Arch Guide. Patches will be submitted to remove old content from the Ops Guide. Team is currently reviewing enterprise ops documentation to incorporate into the Ops Guide. '''API Guide: Anne Gentle''' Check out all the open reviews for api-ref: https://review.openstack.org/#/q/status:open+file:api-ref Nice. Went to weekly team meeting for swift, landed build patch for swift's api-ref, responding to reviews. Noodling with Karen Bradshaw about API navigation, https://review.openstack.org/#/c/329508/ (though I can't take any credit for the work!) '''Config/CLI Ref: Tomoyuki Kato''' Closed many bugs continuously. Started working on the common configurations for shared services and libraries. '''Training labs: Pranav Salunke, Roger Luethi''' No report this week. '''Training Guides: Matjaz Pancur''' No report this week. '''Hypervisor Tuning Guide: Blair Bethwaite No report this week. '''UX/UI Guidelines: Michael Tullis, Stephen Ballard''' No report this week. == Training Guides/Labs Core Team Changes == We've adjusted the training guides and labs core teams so that speciality team leads are core in their own repos, and the docs core team is an 'included group' in both repos. This is intended to stop the core teams for these groups drifting out of date too quickly. Note that it is expected that docs cores will not be the primary reviewers/mergers for training repos, but are there as backup in case extra eyes are needed. That responsibility will continue to lie with the training teams themselves, as they know the codebase the best. You can see the updated core team lists here: Training Guides: https://review.openstack.org/#/admin/groups/uuid-3490bf37012cb344104cb315f3dd5c76dabea62f,members Training Labs: https://review.openstack.org/#/admin/groups/1118,members == Site Stats == During May the top viewed book was the Mitaka Ubuntu Install Guide, followed closely by the Mitaka RDO Install Guide. Rolling into third place was the Admin Guide. Also, apologies for an error I made in this section last week. The correct number for the total number of views in May was 2,365,626. == Doc team meeting == Next meetings: The APAC meeting was held this week, you can read the minutes here: https://wiki.openstack.org/wiki/Documentation/MeetingLogs#2016-06-15 Next meetings: US: Wednesday 22 June, 19:00 UTC APAC: Wednesday 29 June, 00:30 UTC Please go ahead and add any agenda items to the meeting page here: https://wiki.openstack.org/wiki/Meetings/DocTeamMeeting#Agenda_for_next_meeting -- Keep on doc'ing! Lana https://wiki.openstack.org/wiki/Documentation/WhatsUpDoc#17_June_2016 -- Lana Brindley Technical Writer Rackspace Cloud Builders Australia http://lanabrindley.com signature.asc Description: OpenPGP digital signature __ OpenStack Development Mailing List (not for usage questions) Unsubscribe: openstack-dev-requ...@lists.openstack.org?subject:unsubscribe http
[Openstack-operators] [docs] An Ops CPL?
Hi everyone, As you should already know, docs have a number of cross-project liaisons (CPLs)[1], which is basically a list of contact people from each project that docs can go to to ask subject matter questions. This is a great system, and we love being able to contact people directly to get answers. However, it occurred to me recently that we don't have a central go-to person for Ops questions. This has come up a bit recently with the work we're doing on the Ops guide, but I've also noticed a few older bugs lurking in our queue that really need some solid Ops advice. In short, I'd like to have an Ops docs liaison. It would give docs someone to go to to find out if we're doing it right, and it gives Ops a voice within docs and a way to help drive the way Ops documentation is created and maintained (and we have a lot of it these days!). Any volunteers? Thanks, Lana 1: https://wiki.openstack.org/wiki/CrossProjectLiaisons#Documentation -- Lana Brindley Technical Writer Rackspace Cloud Builders Australia http://lanabrindley.com signature.asc Description: OpenPGP digital signature ___ OpenStack-operators mailing list OpenStack-operators@lists.openstack.org http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-operators
[openstack-dev] What's Up, Doc? 10 June 2016
Hi everyone, My week has been spent on the Install Guide, and a big thanks to Andreas for getting the Infra patch up and documenting the new process. The Install Guide team meeting was well attended this week, and I've been following up on the actions from that. I also contacted the cross project liaisons with the information they need to get their content moved, and I'm looking forward to seeing some of these start work next week. In other news, Joseph has been busy reviewing the User Guides, and could use a little help working on the information architecture, and getting a few new projects documented. User Guide meetings are held in US and APAC timezones and volunteers are essential to get this effort complete for Newton. Get all the info here: https://wiki.openstack.org/wiki/User_Guides == Progress towards Newton == 117 days to go! Bugs closed so far: 163 Newton deliverables: https://wiki.openstack.org/wiki/Documentation/NewtonDeliverables Feel free to add more detail and cross things off as they are achieved throughout the release. == Speciality Team Reports == '''HA Guide: Bogdan Dobrelya''' No report this week. '''Install Guide: Lana Brindley''' Infra patch: https://review.openstack.org/#/c/326039/ Instructions: http://docs.openstack.org/contributor-guide/project-install-guide.html Next meeting: Tue 21 June 0600 UTC '''Networking Guide: Edgar Magana''' No meeting this week. Working on a better ToC for the guide that may impact of the of scenarios. Moving more networking content from other guides into the Networking one in order to keep everything in one central point and better updated. '''Security Guide: Nathaniel Dillon''' No report this week. '''User Guides: Joseph Robinson''' Outstanding Tasks - Contacting more project teams for inclusion status, IA plans for the new guide. Some team discussion on fixing old links - contact me if anyone is interested in contributing more content to the User Guides team. '''Ops Guide: Shilla Saebi''' Ops tasks are documented here: https://etherpad.openstack.org/p/ops-arch-tasks OpenStack ops guide reorg in progress & documented here: https://etherpad.openstack.org/p/ops-guide-reorg Working on posting enterprise docs for cleanup. Looking for volunteers in ops/arch docs group to attend ops specific meetings to find additional info and help. '''API Guide: Anne Gentle''' Call for help for unified all-OpenStack API navigation design: http://lists.openstack.org/pipermail/openstack-docs/2016-June/008730.html Discussing project-level organization in https://review.openstack.org/312259 Discussing source organization in https://review.openstack.org/314819 Redirects and deletions in api-site are welcomed! For example, see https://review.openstack.org/327399 Updated README for api-site: https://review.openstack.org/327395 '''Config/CLI Ref: Tomoyuki Kato''' Closed a few bugs continuously. Cleaned up many bugs about tool-generated configuration options that are already released for Mitaka. **We need folks for vendor plug-in docs from each vendor.** '''Training labs: Pranav Salunke, Roger Luethi''' Working on the training-labs landing page to make it look much better. Reintroducing the tooling to build zip files. Working on PXE support for baremetal provisioning. Working on Python port of training-labs. '''Training Guides: Matjaz Pancur''' No report this week. '''Hypervisor Tuning Guide: Blair Bethwaite No report this week. '''UX/UI Guidelines: Michael Tullis, Stephen Ballard''' No report this week. == Site Stats == During May, the docs.openstack.org site had 620 sessions, with just under 20% by new users. The average time of all sessions for the month was about 5 and a half minutes, looking at an average of 3 and a half pages. == Doc team meeting == Next meetings: The US meeting was held this week, you can read the minutes here: https://wiki.openstack.org/wiki/Documentation/MeetingLogs#2016-06-08 Next meetings: APAC: Wednesday 15 June, 00:30 UTC US: Wednesday 22 June, 19:00 UTC Please go ahead and add any agenda items to the meeting page here: https://wiki.openstack.org/wiki/Meetings/DocTeamMeeting#Agenda_for_next_meeting -- Keep on doc'ing! Lana https://wiki.openstack.org/wiki/Documentation/WhatsUpDoc#10_June_2016 -- Lana Brindley Technical Writer Rackspace Cloud Builders Australia http://lanabrindley.com signature.asc Description: OpenPGP digital 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
[openstack-dev] What's Up, Doc? 3 June 2016
Hi everyone,
I'm very pleased to be able to announce the results of our Install Guide naming
poll this week. We ended up with 31 responses, and a very clear winner in
"OpenStack Installation Tutorial". Thank you to everyone who voted! Also, just
a note that I'm still very much in need of representatives from the various
project teams to pitch in and help us get things running. Please make sure your
project is represented by coming along to meetings, or at least contacting us
through the mailing list.
This week I've also spent some time with the Upstream training team,
identifying gaps in the current material, and preparing for Barcelona.
== Progress towards Newton ==
124 days to go!
Bugs closed so far: 134
Newton deliverables
https://wiki.openstack.org/wiki/Documentation/NewtonDeliverables
Feel free to add more detail and cross things off as they are achieved
throughout the release.
== Speciality Team Reports ==
'''HA Guide: Bogdan Dobrelya'''
No report this week.
'''Install Guide: Lana Brindley'''
Poll concluded, winner is "OpenStack Installation Tutorial". Connected with
CPLs this week to encourage more participation. Next meeting: Tue 7 June 0600
UTC.
'''Networking Guide: Edgar Magana'''
Moved DHCP HA chapter to Networking Guide for better maintenance and updates.
Planning to move more sections and focus on DVR HA. Suffering of very low
attendance for the IRC meeting.
'''Security Guide: Nathaniel Dillon'''
No report this week.
'''User Guides: Joseph Robinson'''
Some contact with the Magnum team. Held meetings, brought up the link changes,
which is something I most need some assistance with. IA plan still forthcoming.
'''Ops Guide: Shilla Saebi'''
No report this week.
'''API Guide: Anne Gentle'''
New layout for API reference docs from additions to openstackdocs theme. Also
already added four-color scheme for GET/PUT/POST/DELETE Thanks Graham Hayes!
Work in progress here: https://api.os.gra.ham.ie/compute/
Reviews:
https://review.openstack.org/#/q/project:openstack/openstackdocstheme+status:open
and https://review.openstack.org/#/q/project:openstack/os-api-ref+status:open
Discussion on SDKs and FirstApp audience happening on user-committee list:
http://lists.openstack.org/pipermail/user-committee/2016-May/000889.html
'''Config/CLI Ref: Tomoyuki Kato'''
Closed some bugs with Mitaka backport. Fixed the incorrect RST markup at the
new options section, with generation tool update.
'''Training labs: Pranav Salunke, Roger Luethi'''
No report this week.
'''Training Guides: Matjaz Pancur'''
Upstream training updates, Barcelona schedule.
'''Hypervisor Tuning Guide: Blair Bethwaite
No report this week.
'''UX/UI Guidelines: Michael Tullis, Stephen Ballard'''
The first prototype of content was presented and source information gaps were
identified. A first draft will be complete by June 9.
== Site Stats ==
In the Install Guide naming poll, "OpenStack Installation Tutorial" finished
with 29% of the vote, well ahead of "OpenStack Evaluation Setup Guide" at 19%,
and "Basic Install Guide" at 16%. And, because charts are fun, here are the
final results:
https://docs.google.com/spreadsheets/d/1VlNFebI_KFobs-XIT5oRhULRymwrqON8SV9pH4uiYIQ/pubchart?oid=2070399201=image
I personally thought "OpenStack from Scratch" was the most creative title. And
the potentially confusing "Manual Install Guide" ("Guided Install Manual"?) had
a small following at just under 10% of the vote. Thanks for all the great
suggestions :)
== Doc team meeting ==
Next meetings:
The APAC meeting was held this week, you can read the minutes here:
https://wiki.openstack.org/wiki/Documentation/MeetingLogs#2016-06-01
Next meetings:
US: Wednesday 8 June, 19:00 UTC
APAC: Wednesday 15 June, 00:30 UTC
Please go ahead and add any agenda items to the meeting page here:
https://wiki.openstack.org/wiki/Meetings/DocTeamMeeting#Agenda_for_next_meeting
--
Keep on doc'ing!
Lana
https://wiki.openstack.org/wiki/Documentation/WhatsUpDoc#3_June_2016
--
Lana Brindley
Technical Writer
Rackspace Cloud Builders Australia
http://lanabrindley.com
signature.asc
Description: OpenPGP digital 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
[openstack-dev] What's Up, Doc? 27 May 2016
Hi everyone, This week I've been focused on getting the Install Guide project back up and running, with the team meeting being rebooted, our specs finally merged, and organising the list of tasks to be getting on with. Also, don't forget to vote in our naming poll: http://goo.gl/forms/Eqf9WOGqsXjkRbdc2 I'm still very much in need of representatives from the various project teams to pitch in and help us get things running. Please make sure your project is represented by coming along to meetings, or at least contacting us through the mailing list. In other news, the Ops and Arch Guide re-architecture is proceeding apace. Specs were merged this week, and the new Arch Guide ToC is looking great! Check it out here: http://specs.openstack.org/openstack/docs-specs/specs/newton/arch-guide-restructure.html We are also still looking for feedback on the current Ops guide. Add your notes here: https://etherpad.openstack.org/p/ops-guide-reorg == Progress towards Newton == 131 days to go! Bugs closed so far: 107 Newton deliverables https://wiki.openstack.org/wiki/Documentation/NewtonDeliverables Feel free to add more detail and cross things off as they are achieved throughout the release. == Speciality Team Reports == '''HA Guide: Bogdan Dobrelya''' No report this week. '''Install Guide: Lana Brindley''' Specs are now merged, an blueprints created. Tasks listed here: https://wiki.openstack.org/wiki/Documentation/InstallGuideWorkItems Please go ahead and pick up work items. Need project representation in meetings. Next meeting: Tue 7 June 0600 UTC '''Networking Guide: Edgar Magana''' We did not have meeting this week. Nothing to report. Next IRC meeting: Thursday June 2nd at 1600 UTC '''Security Guide: Nathaniel Dillon''' No report this week. '''User Guides: Joseph Robinson''' Action items to follow up - email meeting minutes to the mailing list to update the community. Currently, the team has two contributors. Please let me know if you're interested in working on the User Guide Team. '''Ops Guide: Shilla Saebi''' Shilla & Darren working on collecting enterprise docs to push upstream Ops tasks are documented here: https://etherpad.openstack.org/p/ops-arch-tasks OpenStack ops guide reorg in progress & documented here: https://etherpad.openstack.org/p/ops-guide-reorg Spec was merged: https://review.openstack.org/#/c/311998/ '''API Guide: Anne Gentle''' No report this week. '''Config/CLI Ref: Tomoyuki Kato''' A few configuration docs patches for some vendor plug-ins has been merged, with mitaka backport. Heat CLI is marked as deprecated. '''Training labs: Pranav Salunke, Roger Luethi''' No report this week. '''Training Guides: Matjaz Pancur''' Updates for Upstream training material '''Hypervisor Tuning Guide: Blair Bethwaite No report this week. '''UX/UI Guidelines: Michael Tullis, Stephen Ballard''' No report this week. == Site Stats == This month, two thirds of our site visitors have been using their Mac to read the docs. Just under 30% used Windows, and Linux rounded out the remainder at 4%. So far in the Install Guide naming poll, "OpenStack Installation Tutorial" has a commanding lead at 30%, with "Basic Install Guide" and "OpenStack Evaluation Setup Guide" (try saying that ten times fast!) tying for second place with 17% of the vote each. I'll keep the poll open for another week or so, and announce our winning name in next week's newsletter. == Doc team meeting == Next meetings: The US meeting was held this week, you can read the minutes here: https://wiki.openstack.org/wiki/Documentation/MeetingLogs#2016-05-25 Next meetings: APAC: Wednesday 1 June, 00:30 UTC US: Wednesday 8 June, 19:00 UTC Please go ahead and add any agenda items to the meeting page here: https://wiki.openstack.org/wiki/Meetings/DocTeamMeeting#Agenda_for_next_meeting -- Keep on doc'ing! Lana https://wiki.openstack.org/wiki/Documentation/WhatsUpDoc#27_May_2016 -- Lana Brindley Technical Writer Rackspace Cloud Builders Australia http://lanabrindley.com signature.asc Description: OpenPGP digital 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
[openstack-dev] [docs][install-guide] Install Guide Naming
Hi everyone, As part of the massive Install Guide changes the docs team are implementing in Newton, we need to come up with a name for what *was* the Install Guide. We need to emphasise the fact that it should be used for learning purposes only, not for installing a production cloud. So go ahead and tell us what you think! http://goo.gl/forms/HqyXIU4cjRB4xfN43 Thanks! Lana -- Lana Brindley Technical Writer Rackspace Cloud Builders Australia http://lanabrindley.com signature.asc Description: OpenPGP digital 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
[openstack-dev] What's Up, Doc? 20 May 2016
Hi everyone, I've been struck down by the dreaded flu this week, so it's been a bit quiet around here. I have, however, crawled out from under the tissues, throat lozenges, and episodes of Containment to pen my regular newsletter for you. See how dedicated I am to the cause? ;) The biggest updates this week have been on the API side of the ship, with the api-site bug list cleared out. Well done to Anne and Atsushi-san for the heavy lifting there. We also saw a lot of speciality team meetings kick off again this week, with more coming next week, so keep an eye on the mailing list and your ical for the projects you're interested in. We have also now hit our stride on the regular docs meetings, with the APAC meeting held this week, and the US one rolling around again next week. If you're a docs cross-project liaison, make sure you check out the timing and pick one that works for you, so we can make sure we're discussing *your* project. == Progress towards Newton == 138 days to go! Bugs closed so far: 89 Newton deliverables https://wiki.openstack.org/wiki/Documentation/NewtonDeliverables Feel free to add more detail and cross things off as they are achieved throughout the release. I will also do my best to ensure it's kept up to date for each newsletter. == Speciality Team Reports == '''HA Guide: Bogdan Dobrelya''' No report this week. '''Install Guide: Lana Brindley''' Meetings start up next week: http://eavesdrop.openstack.org/#Documentation_Install_Team_Meeting Cookie cutter has been merged, repo here: http://git.openstack.org/cgit/openstack/installguide-cookiecutter/ Need to merge spec: https://review.openstack.org/#/c/310588 '''Networking Guide: Edgar Magana''' We have successfully changed the bi-weekly meeting schedule from odd to even weeks. There will not be meeting this week. Next meeting will be on June 2nd. '''Security Guide: Nathaniel Dillon''' No report this week. '''User Guides: Joseph Robinson''' Team Meeting restarted - Just me this week, I'll send a summary to the mailing list to keep everyone up to date, and if anyone is interested in joining in. Python SDK file moving - one item left from the Mitaka patch - Finding a location to move these files - dev and doc mailing list email forthcoming on where to put these files. '''Ops Guide: Shilla Saebi''' No report this week. '''API Guide: Anne Gentle''' The extension, os-api-ref, is now available via Pypi so that all projects can re-use it with test-requirements.txt. Thanks Sean Dague for this effort! Several projects have reviews in progress for their API reference conversion: glance https://review.openstack.org/#/c/312259/, manila https://review.openstack.org/#/c/313874, neutron https://review.openstack.org/#/c/314819, swift https://review.openstack.org/#/c/312315/, trove https://review.openstack.org/#/c/316381. (There are probably more but those are on my radar). Please review the response code table at https://review.openstack.org/#/c/318281/ and http://i.imgur.com/onsRFtI.png for your use cases for API reference docs. '''Config/CLI Ref: Tomoyuki Kato''' No report this week. '''Training labs: Pranav Salunke, Roger Luethi''' No report this week. '''Training Guides: Matjaz Pancur''' Work on the slides for Training guides (https://review.openstack.org/#/c/295016/) Feedback about Upstream training in Austin (see http://eavesdrop.openstack.org/meetings/training_guides/2016/training_guides.2016-05-16-17.02.html) '''Hypervisor Tuning Guide: Blair Bethwaite Hi! I'm going to try looking after this for a while as Joe focuses on other things. Not promising much at this point beyond a little wiki gardening, but longer term I hope to align it with some activities in the scientific-wg (which I'm co-chairing with Stig Telfer), and it will probably become a point of reference for some of the activities we already have planned this cycle. '''UX/UI Guidelines: Michael Tullis, Stephen Ballard''' No report this week. == Site Stats == While 90% of our readers have their browsers set to US English, just under 8% browse in Chinese, and a mere 0.15% use British English. That last one might be just me ;) == Doc team meeting == Next meetings: The APAC meeting was held this week, you can read the minutes here: https://wiki.openstack.org/wiki/Documentation/MeetingLogs#2016-05-18 Next meetings: US: Wednesday 25 May, 19:00 UTC APAC: Wednesday 1 June, 00:30 UTC Please go ahead and add any agenda items to the meeting page here: https://wiki.openstack.org/wiki/Meetings/DocTeamMeeting#Agenda_for_next_meeting -- Keep on doc'ing! Lana https://wiki.openstack.org/wiki/Documentation/WhatsUpDoc#20_May_2016 -- Lana Brindley Technical Writer Rackspace Cloud Builders Australia http://lanabrindley.com signature.asc Description: OpenPGP digital signature __ OpenStack Development Mailing List (not for usage questions) Unsubscribe: openstack
[openstack-dev] What's Up, Doc? 13 May
= 13 May 2016 = Hi everyone, Wow, what a busy week! I've been mainly focused on the Install Guide speciality team this week, with gathering interested participants, ensuring our specs are ready to be merged, and setting a new meeting time. I'm also pleased to say that our speciality team reports make a post-Summit comeback in this newsletter. Just another reminder that all projects should update their cross-project liaison for docs on the wiki here: https://wiki.openstack.org/wiki/CrossProjectLiaisons#Documentation If you're one of the lucky people nominated by your PTL to be a docs CPL, then please do your very best to attend docs meetings in your favourite timezone to make sure we hear the voice of your project when we're making documentation decisions. Details of upcoming docs meetings are at the end of this newsletter every week. On a related note, it was refreshing to read the conversation from the US meeting this week, and the associated conversation on the mailing lists about developer contributions to documentation. We'd love to find out what it is that prevents you from contributing to the docs, and what the docs team can do to make things that little bit easier for you! Reach out to us either on the dev mailing list (with [docs] in the subject line), or on the docs mailing list at openstack-d...@lists.openstack.org. == Progress towards Newton == 145 days to go! Bugs closed so far: 71 Newton deliverables https://wiki.openstack.org/wiki/Documentation/NewtonDeliverables Feel free to add more detail and cross things off as they are achieved throughout the release. I will also do my best to ensure it's kept up to date for each newsletter. The Ops and HA Guides now exist in openstack-manuals, and the old repos have now been set to read-only. We also have the first patch in for the Install Guide 'cookie cutter' template, which is a great start! == Speciality Team Reports == '''HA Guide: Bogdan Dobrelya''' No report this week. '''Install Guide: Lana Brindley''' New meeting time proposed: https://review.openstack.org/#/c/314831/ Still need to merge final spec: https://review.openstack.org/#/c/310588/ If you're interested in helping out, add your name here: https://wiki.openstack.org/wiki/Documentation/InstallGuide#Team_members '''Networking Guide: Edgar Magana''' We are planning to resume the meeting next week. '''Security Guide: Nathaniel Dillon''' Summit Recap: https://etherpad.openstack.org/p/austin-docs-workgroup-security Good conversations around API rate limiting, OSSN in-flight, SecGuide work being prep'd (Thanks to Luke Hinds for taking this on!) Added Doc reviewer (Thanks Shilla and welcome!) Will be focusing on Neutron security '''User Guides: Joseph Robinson''' No report this week. '''Ops Guide: Shilla Saebi''' Proposed architecture guide restructure: https://review.openstack.org/#/c/311998/ Ops guide session Etherpad from Austin: https://etherpad.openstack.org/p/AUS-ops-Docs-ops-guide OpsGuide reorg: https://etherpad.openstack.org/p/PAO-ops-ops-guide-fixing Newton Plans: Review content of both guides, and delete anything out of date Review architecture of both guides, and possibly combine Ops Guide in openstack-manuals repo Gather content from Ops internal documentation '''API Guide: Anne Gentle''' All but two services have someone working on landing a migration patch in the project's repo. Read: Status on bugs and migration http://lists.openstack.org/pipermail/openstack-docs/2016-May/008624.html Read: Summit session recap http://lists.openstack.org/pipermail/openstack-dev/2016-May/094472.html '''Config/CLI Ref: Tomoyuki Kato''' Discussing documenting auto generation of config options with Oslo team. Dropped keystone command-line client from CLI reference. Keystone CLI was removed in python-keystoneclient 3.0.0 release. '''Training labs: Pranav Salunke, Roger Luethi''' Working on adding new features like PXE boot. Stabilizing current release and backends. Figuring out the zip file generation and web site/page. Chaging the meeting time to more CET/CEST friendly time. '''Training Guides: Matjaz Pancur''' No report this week. '''Hypervisor Tuning Guide: Joe Topjian''' No report this week. '''UX/UI Guidelines: Michael Tullis, Stephen Ballard''' No report this week. == Site Stats == The interesting fact I'd like to share with you this week is that just over 25% of our viewers this month are new to the site. == Doc team meeting == Next meetings: The US meeting was held this week, you can read the minutes here: https://wiki.openstack.org/wiki/Documentation/MeetingLogs#2016-05-11 Next meetings: APAC: Wednesday 18 May, 00:30 UTC US: Wednesday 25 May, 19:00 UTC Please go ahead and add any agenda items to the meeting page here: https://wiki.openstack.org/wiki/Meetings/DocTeamMeeting#Agenda_for_next_meeting -- Keep on doc'ing! Lana https://wiki.openstack.org/wiki/Documentation/WhatsUpDoc#13_May_2016 -- Lana Brindley Technical Writer
Re: [openstack-dev] [cinder][doc]An error in OpenStack architecture picture
On 11/05/16 12:58, hao wang wrote: > Hi, stackers, > > I found an error in OpenStack architecture picture in docs: > http://docs.openstack.org/openstack-ops/content/architecture.html. > > In OpenStack Logical Architecture picture, Cinder's database is named "nova > database", it's not correct. It should be "cinder database". > I create a bug for you: https://bugs.launchpad.net/openstack-manuals/+bug/1580424 L -- Lana Brindley Technical Writer Rackspace Cloud Builders Australia http://lanabrindley.com signature.asc Description: OpenPGP digital 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
[openstack-dev] [PTL][docs]Update your cross-project liaison!
Hi everyone, OpenStack use cross project liaisons to ensure that projects are talking to each effectively, and the docs CPLs are especially important to the documentation team to ensure we have accurate docs. Can all PTLs please take a moment to check (and update if necessary) their CPL listed here: https://wiki.openstack.org/wiki/CrossProjectLiaisons#Documentation Thanks a bunch! Lana -- Lana Brindley Technical Writer Rackspace Cloud Builders Australia http://lanabrindley.com signature.asc Description: OpenPGP digital 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] Easing contributions to central documentation
On 10/05/16 20:08, Julien Danjou wrote: > On Mon, May 09 2016, Matt Kassawara wrote: > >> So, before developer frustrations drive some or all projects to move >> their documentation in-tree which which negatively impacts the goal of >> presenting a coherent product, I suggest establishing an agreement >> between developers and the documentation team regarding the review >> process. > > My 2c, but it's said all over the place that OpenStack is not a product, > but a framework. So perhaps the goal you're pursuing is not working > because it's not accessible by design? > >> 1) The documentation team should review the patch for compliance with >> conventions (proper structure, format, grammar, spelling, etc.) and provide >> feedback to the developer who updates the patch. >> 2) The documentation team should modify the patch to make it compliant and >> ask the developer for a final review to prior to merging it. >> 3) The documentation team should only modify the patch to make it build (if >> necessary) and quickly merge it with a documentation bug to resolve any >> compliance problems in a future patch by the documentation team. >> >> What do you think? > > We, Telemetry, are moving our documentation in-tree and are applying a > policy of "no doc, no merge" (same policy we had for unit tests). This is great news! I love hearing stories like this from project teams who recognise the important of documentation. Hopefully the new model for Install Guides will help you out here, too. > So until the doc team starts to help projects with that (proof-reading, > pointing out missing doc update in patches, etc) and trying to be part > of actual OpenStack projects, I don't think your goal will ever work. > > For example, we have an up-to-date documentation in Gnocchi since the > beginning, that covers the whole project. It's probably not coherent > with the rest of OpenStack in wording etc, but we'd be delighted to have > some folks of the doc team help us with that. Let's work together to find out how we can help. I note that Lance Bragstad is your CPL, is that still current? Lana -- Lana Brindley Technical Writer Rackspace Cloud Builders Australia http://lanabrindley.com signature.asc Description: OpenPGP digital 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
[openstack-dev] What's Up, Doc? 6 May 2016
Hi everyone, I hope you all had a safe journey home from Summit, and are now fully recovered from all the excitement (and jetlag)! I'm really pleased with the amount of progress we made this time around. We have a definitive set of goals for Newton, and I'm confident that they're all moving us towards a much better docs suite overall. Of course, the biggest and most important work we have to do is to get our Install Guide changes underway. I'm very excited to see the new method for documenting OpenStack installation, and can't wait to see all our big tent projects contributing to docs in such a meaningful way. Thank you to everyone (in the room and online) who contributed to the Install Guide discussion, and helped us move forward on this important project. In other news, I've written a wrapup of the Austin design summit on my blog, which you might be interested in: http://lanabrindley.com/2016/05/05/openstack-newton-summit-docs-wrapup/ == Progress towards Newton == 152 days to go! Bugs closed so far: 61 Because we have such a specific set of deliverables carved out for Newton, I've made them their own wiki page: https://wiki.openstack.org/wiki/Documentation/NewtonDeliverables Feel free to add more detail and cross things off as they are achieved throughout the release. I will also do my best to ensure it's kept up to date for each newsletter. One of the first tasks we've started work on after Summit is moving the Ops and HA Guides out of their own repositories and into openstack-manuals. As a result, those repositories are now frozen, and any work you want to do on those books should be in openstack-manuals. We are almost ready to publish the new RST version of the Ops Guide, there's just a few cleanup edits going in now, so make sure you have the right book, in the right repo from now on. This was our very last book remaining in DocBook XML, so the docs toolchain will be removing DocBook XML support. See spec https://review.openstack.org/311698 for details. Another migration note is that the API reference content is moving from api-site to project specific repositories and api-site is now frozen. For more detail, see Anne's email: http://lists.openstack.org/pipermail/openstack-docs/2016-May/008536.html == Mitaka wrapup == We performed a Mitaka retrospective at Summit, notes are here: https://etherpad.openstack.org/p/austin-docs-mitakaretro In particular, I'd like to call out our hard working tools team Andreas and Christian, all our Speciality Team leads, and the Mitaka release managers Brian and Olga. Well done on a very successful release, everyone :) Total bugs closed: 645 == Site Stats == Thanks to the lovely people at Foundation (thanks Allison!) I now have access to more stats than I could possibly guess what to do with, and I'm hoping to be able to share some of these with you through the newsletter. If there's something in particular you would like to see, then please let me know and I'll endeavour to record it here! So far I can tell you that docs.openstack.org had 1.63M unique pageviews in April, down slightly from 1.72M in March, and the average session duration is just over six minutes, looking at just under 4 pages per session. == Doc team meeting == Next meetings: We'll be restarting the meeting series next week. Next meetings: US: Wednesday 11 April, 19:00 UTC APAC: Wednesday 18 April, 00:30 UTC Please go ahead and add any agenda items to the meeting page here: https://wiki.openstack.org/wiki/Meetings/DocTeamMeeting#Agenda_for_next_meeting -- Keep on doc'ing! Lana https://wiki.openstack.org/wiki/Documentation/WhatsUpDoc#6_May_2016 -- Lana Brindley Technical Writer Rackspace Cloud Builders Australia http://lanabrindley.com signature.asc Description: OpenPGP digital 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] Requirements for becoming approved official project
Hi Shinobu, I can help you with the documentation piece, at least. The documentation team are working on a new method to help projects document their installation guides in their own repo, with publishing to docs.openstack.org. This is explicitly to help projects meet the project navigator requirements. Before Newton, we will have the infrastructure up, and hope to also have a template and some other guides for you to help you do this. If you have questions about getting started on this, please email the docs mailing list: openstack-d...@lists.openstack.org Thanks, Lana On 29/04/16 22:40, Shinobu Kinjo wrote: > Hi Tom, > > First sorry for bothering you -; > > We are trying to make the tricircle project [1] one of the opnestack > official projects. And we are referring to project team guide to make > sure what are requirements. [2]. Reading this guide, what we need to > consider right now is open development, I think (but not 100% sure). > [3] > > We have a blueprint. [4] We also have git repositories in > openstack.org and github.com. [5] [6] > There is a few bugs filed. [7] There are few contributors. > > What we don't have now is official documentation which is supposed to > be located at openstack.org. [8] This is because we are not officially > approved project. [9] This situation is now huge bottleneck for our > project. > > There were some advices from one of developers, which pointed to > guides. [1] [10] > If you could provide some suggestions, advices or no matter what are > really necessary for becoming officially approved project with us, it > would be MUCH appreciated. > > [1] https://wiki.openstack.org/wiki/Tricircle > [2] http://docs.openstack.org/project-team-guide/ > [3] http://docs.openstack.org/project-team-guide/open-development.html > [4]https://launchpad.net/tricircle > [5] https://git.openstack.org/openstack/tricircle > [6] https://github.com/openstack/tricircle/ > [7] http://bugs.launchpad.net/tricircle > [8] http://docs.openstack.org/developer/tricircle > [9] > http://docs.openstack.org/infra/manual/creators.html#add-link-to-your-developer-documentation > [10] http://governance.openstack.org/reference/new-projects-requirements.html > > Thanks for your great help in advance! > > Cheers, > Shinobu > > __ > 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 > -- Lana Brindley Technical Writer Rackspace Cloud Builders Australia http://lanabrindley.com signature.asc Description: OpenPGP digital 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
[openstack-dev] [Docs] Installation Guide Plans for Newton
Greetings from Austin! Yesterday we held the Install Guide planning workgroup. It was a full room, with some very robust discussion, and I want to thank everyone for participating and sharing their thoughts on this matter. We have some solid goals to achieve for Newton now. The etherpad with the discussion is here: https://etherpad.openstack.org/p/austin-docs-workgroup-install The original spec to create a way for projects to publish Instal Guides has now been merged, thanks to consensus being achieved at the Design Summit session, and a few minor edits: https://review.openstack.org/#/c/301284/ We can now begin work on this. There is a new spec up to cover the remainder of the work to be done on the existing Install Guide: https://review.openstack.org/#/c/310588 This still needs some iterations to get it into shape (including determining the name we are going to use for the Install Guide). So, patches welcome. Again, thank you to all the many people who attended the session, and those who have found me this week and discussed the future of the Install Guide. I'm confident that this plan has broad acceptance, is achievable during the Newton cycle, and it moves the documentation project forward. Feedback is, as always, very welcome. Lana -- Lana Brindley Technical Writer Rackspace Cloud Builders Australia http://lanabrindley.com signature.asc Description: OpenPGP digital 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] [openstack-manuals] What the status of DocImpact
No trouble. Yes, the config changes should be picked up automatically. You can't edit those files in the book directly, as a script writes them. That's why your change would have been declined. Thanks for asking the question, though :) L On 24/04/16 11:12, ZhiQiang Fan wrote: > Hi Lana, > > Thank you for explaining it! > > Yes, I noticed that the DocImpact bug track now has shifted to project its > own, that why I submit a change by using the tool in openstack-doc-tools, but > that change is disagreed by a doc core. Meanwhile I also find that there is > rarely change merged for config reference update. > > So I want to know is the config reference automatically updated so no more > individual commit is required? > > Best Regards, > > On Sun, Apr 24, 2016 at 11:28 PM, Lana Brindley <openst...@lanabrindley.com > <mailto:openst...@lanabrindley.com>> wrote: > > Hi ZhiQiang, > > I am not sure I understand your question. The only change to DocImpact is > that now the bug is created in the project's bug queue, not OpenStack > manuals. There is no other automation for DocImpact. > > For the config ref, there is a script that we run to get any new changes. > That will happen whether or not there is a DocImpact bug. > > Does that answer your question? > > Thanks, > Lana > > On 23/04/16 19:00, ZhiQiang Fan wrote: > > Hi Doc Team, > > > > I want to know the recent status of DocImpact tag, is it deprecated for > config option changes now? If it's true, then what the workflow for config > reference now, any hint or link? > > > > Previously, when a patch has impact to document, including config > option changes, I usually ask contributors to add a DocImpact, hence there > will be a bug track the document issue. > > > > Recently, a patch lands in Ceilometer which adds two new options, and > Ceilometer receives the auto created document bug. However, when I submit a > patch to openstack-manuals to fix it, I was told by a core that such change > is not needed any more, I searched latest merged patch in openstack-manuals > and found what he said is true, but still don't know why and what action I > should follow in Ceilometer/Aodh projects > > > > Thank you very much! > > > > ZhiQiang Fan > > > > > > > __ > > OpenStack Development Mailing List (not for usage questions) > > Unsubscribe: > openstack-dev-requ...@lists.openstack.org?subject:unsubscribe > <http://openstack-dev-requ...@lists.openstack.org?subject:unsubscribe> > > http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-dev > > > > -- > Lana Brindley > Technical Writer > Rackspace Cloud Builders Australia > http://lanabrindley.com > > > __ > OpenStack Development Mailing List (not for usage questions) > Unsubscribe: > openstack-dev-requ...@lists.openstack.org?subject:unsubscribe > <http://openstack-dev-requ...@lists.openstack.org?subject:unsubscribe> > http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-dev > > > > > __ > 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 > -- Lana Brindley Technical Writer Rackspace Cloud Builders Australia http://lanabrindley.com signature.asc Description: OpenPGP digital 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] [openstack-manuals] What the status of DocImpact
Hi ZhiQiang, I am not sure I understand your question. The only change to DocImpact is that now the bug is created in the project's bug queue, not OpenStack manuals. There is no other automation for DocImpact. For the config ref, there is a script that we run to get any new changes. That will happen whether or not there is a DocImpact bug. Does that answer your question? Thanks, Lana On 23/04/16 19:00, ZhiQiang Fan wrote: > Hi Doc Team, > > I want to know the recent status of DocImpact tag, is it deprecated for > config option changes now? If it's true, then what the workflow for config > reference now, any hint or link? > > Previously, when a patch has impact to document, including config option > changes, I usually ask contributors to add a DocImpact, hence there will be a > bug track the document issue. > > Recently, a patch lands in Ceilometer which adds two new options, and > Ceilometer receives the auto created document bug. However, when I submit a > patch to openstack-manuals to fix it, I was told by a core that such change > is not needed any more, I searched latest merged patch in openstack-manuals > and found what he said is true, but still don't know why and what action I > should follow in Ceilometer/Aodh projects > > Thank you very much! > > ZhiQiang Fan > > > __ > 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 > -- Lana Brindley Technical Writer Rackspace Cloud Builders Australia http://lanabrindley.com signature.asc Description: OpenPGP digital 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] Our Install Guides Only Cover Defcore - What about big tent?
Hi Jonathan, It's all good, this is actually unrelated to the larger changes proposed for Newton, but more about a late change that was proposed for Kilo. HTH, L On 14/04/16 03:59, Jonathan D. Proulx wrote: > On Wed, Apr 13, 2016 at 01:52:38PM -0400, Jonathan D. Proulx wrote: > > :I've not been following this thread at all so appologies if I'm > :confused. > > reading follow up emails relating to timing of various submissions, I > back away slowly clearly not having all the context on this one. > > -Jon > > __ > 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 > -- Lana Brindley Technical Writer Rackspace Cloud Builders Australia http://lanabrindley.com signature.asc Description: OpenPGP digital 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] [OpenStack-docs] [Docs] Austin Design Summit Sessions - Docs
And just a note that the Ops Guide session is on in the Ops track on Monday morning: https://www.openstack.org/summit/austin-2016/summit-schedule/events/9511 Lana On 11/04/16 12:25, Lana Brindley wrote: > The docs sessions are now in Sched, complete with etherpad links: > https://www.openstack.org/summit/austin-2016/summit-schedule/global-search?t=Documentation%3A > > Note the Install Guide working session is on Wednesday at 11:50, timed so > that we can run into lunch if required. I strongly suggest you attend if you > have an opinion: > https://www.openstack.org/summit/austin-2016/summit-schedule/events/9226 > > Lana > > On 01/04/16 09:49, Lana Brindley wrote: >> Hi everyone, >> >> First of all, thanks for the amazing feedback on what docs sessions you >> would like to see at the Austin Design Summit! >> >> We have filled our entire allocation (and then some), and the schedule so >> far looks something like this: >> >> Fishbowls (40 min slot) x 4 >> >> Mitaka retro - Wed 11 >> Toolchain/Infra session - Wed 16:30 >> Contributor Guide - Thu 9:50 >> Newton planning - Thu 13:30 >> >> Workrooms (40 min slot) x 4 >> >> API Guide Wed 9am >> Install Guide - Wed 11:50 >> Security Guide - Thu 11 >> Networking Guide - Thu 11:50 >> >> Meetup (Friday 14:00-17:30) >> >> Contributors meetup. No agenda. >> >> >> And a note for those who noticed the Ops guide omission: this should take >> place in the Ops track, and I'll let you know when that session will be. >> >> Lana >> > > > > ___ > OpenStack-docs mailing list > openstack-d...@lists.openstack.org > http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-docs > -- Lana Brindley Technical Writer Rackspace Cloud Builders Australia http://lanabrindley.com signature.asc Description: OpenPGP digital 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] Austin Design Summit Sessions - Docs
The docs sessions are now in Sched, complete with etherpad links: https://www.openstack.org/summit/austin-2016/summit-schedule/global-search?t=Documentation%3A Note the Install Guide working session is on Wednesday at 11:50, timed so that we can run into lunch if required. I strongly suggest you attend if you have an opinion: https://www.openstack.org/summit/austin-2016/summit-schedule/events/9226 Lana On 01/04/16 09:49, Lana Brindley wrote: > Hi everyone, > > First of all, thanks for the amazing feedback on what docs sessions you would > like to see at the Austin Design Summit! > > We have filled our entire allocation (and then some), and the schedule so far > looks something like this: > > Fishbowls (40 min slot) x 4 > > Mitaka retro - Wed 11 > Toolchain/Infra session - Wed 16:30 > Contributor Guide - Thu 9:50 > Newton planning - Thu 13:30 > > Workrooms (40 min slot) x 4 > > API Guide Wed 9am > Install Guide - Wed 11:50 > Security Guide - Thu 11 > Networking Guide - Thu 11:50 > > Meetup (Friday 14:00-17:30) > > Contributors meetup. No agenda. > > > And a note for those who noticed the Ops guide omission: this should take > place in the Ops track, and I'll let you know when that session will be. > > Lana > -- Lana Brindley Technical Writer Rackspace Cloud Builders Australia http://lanabrindley.com signature.asc Description: OpenPGP digital 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] Constant attempts from Matthew Kassawara to remove Debian from the install-guide
On 09/04/16 10:05, Anne Gentle wrote: > Okay. I'll try to propose an idea. > > In the Mitaka install spec review, [1] I asked if the drama was worth the > extra effort to remove. Personally I don't believe so, having refereed this > discussion for years now. > > I think you're both reasonable people and do believe in OpenStack. You both > want it to succeed, yet for the particular goals of the install guide you > haven't come to consensus. That's fine. Anne has, as usual, stated my opinion much more eloquently than I ever would be able to. Thomas and Matt, this has been an ongoing feud since well before I was around, and while I understand we're not there yet, every release brings us so much closer to an Install Guide solution that will work for everyone. Not just to get a Debian Install Guide published, but to get an Install Guide that covers every project in the big tent. This conversation, and the many other conversations we have had on this topic over the past few months will again form a large part of the agenda at the design summit, and I look forward to being able to hash this out in more detail then. > > I have another idea for a way forward that doesn't require consensus across > teams. Now that we have the governance in place for debian packaging, let's > move the debian install guide to a new repo that can go under the packaging > project, and you can create and maintain build jobs for the debian install > guide. No one will have the additional burden of maintaining conditional > text. You can write what you like and publish what you want, taking > responsibility for quality control and ongoing maintenance. > > Monty's the PTL for packaging-rpm. [2] Can you envision a > debian-install-guide repo within the packaging-rpm team, with both a review > team and bug triaging only for that repo? You'll need to work on the gate and > build jobs as well, but I truly believe we have the systems in place to > enable this. And with the direction of the individual projects taking > responsibility for their install guides, we have a framework we're moving > towards and this case seems to fit the new framework. [3] > > I think it's a great use of the time you have now, and lets us all stop > losing time to the debate. +1 L -- Lana Brindley Technical Writer Rackspace Cloud Builders Australia http://lanabrindley.com signature.asc Description: OpenPGP digital 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
[openstack-dev] What's Up, Doc? Mitaka Release Edition
Hi everyone, While it was very tempting to write something something shocking here for April Fools', I thought everyone might have already had their heart rate raised enough by the fact that Mitaka is only five days away! This will be my final docs newsletter before the release, and the docs are in great shape ready to go out. I would like to sincerely thank Andreas and our release managers Brian and Olga, not only for the hard work they've done so far, but also for holding down the fort over the next few days while I'm out of contact. Please remember to contact them directly if you have any last minute documentation fires that need putting out. I'd also like to mention the hard work that the Installation Guide testers have been putting in over the past couple of weeks. The testing matrix is looking very green (https://wiki.openstack.org/wiki/Documentation/MitakaDocTesting) and I'm confident that we'll get the Mitaka guide out fully tested and on schedule. Don't forget you can check release progress on the etherpad here: https://etherpad.openstack.org/p/MitakaRelease == Progress towards Mitaka == 5 days to go! 558 bugs closed so far for this release. Docs Testing * https://wiki.openstack.org/wiki/Documentation/MitakaDocTesting * Only a few items left to check off, at this stage we're good to publish the Ubuntu, RDO, and Suse guides on release day. Release Tasks: * Release planning occurs in our etherpad here: https://etherpad.openstack.org/p/MitakaRelease * All tasks that should be completed at this stage are done, and we're on track to start the release process in the 24-48 hours before the release drops. * Release notes for the docs project are in a "reno-style" directory in the openstack-manuals repo. This directory is not being managed by Reno, however, so please propose patches to it directly. == The Road to Austin == * First of all, thanks for the amazing feedback on what docs sessions you would like to see at the Austin Design Summit! We have filled our entire allocation (and then some), and the schedule so far is here: https://etherpad.openstack.org/p/Newton-DocsSessions * There's been a really robust and exciting conversation about the Install Guide on the dev list over the past week or so, which I have been following closely. If you're interested in overhauling our Install Guide (and it certainly seems like a lot of people are!), then please make sure you add our Install Guide Design Summit session to your agenda. It is on Wednesday at 11:50, so placed so that it can run over into lunchtime if required. * A note for those who noticed the Ops guide omission: this should take place in the Ops track, and I'll let you know when that session will be. == Doc team meeting == Next meetings: The US meeting was held this week, you can read the minutes here: https://wiki.openstack.org/wiki/Documentation/MeetingLogs#2016-03-30 Next meetings: APAC: No APAC meeting this week US: Wednesday 13 April, 19:00 UTC (This is after the Mitaka release) Please go ahead and add any agenda items to the meeting page here: https://wiki.openstack.org/wiki/Meetings/DocTeamMeeting#Agenda_for_next_meeting -- Keep on doc'ing! Lana https://wiki.openstack.org/wiki/Documentation/WhatsUpDoc#1_April_2016 -- Lana Brindley Technical Writer Rackspace Cloud Builders Australia http://lanabrindley.com signature.asc Description: OpenPGP digital 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
[openstack-dev] [Docs] Austin Design Summit Sessions - Docs
Hi everyone, First of all, thanks for the amazing feedback on what docs sessions you would like to see at the Austin Design Summit! We have filled our entire allocation (and then some), and the schedule so far looks something like this: Fishbowls (40 min slot) x 4 Mitaka retro - Wed 11 Toolchain/Infra session - Wed 16:30 Contributor Guide - Thu 9:50 Newton planning - Thu 13:30 Workrooms (40 min slot) x 4 API Guide Wed 9am Install Guide - Wed 11:50 Security Guide - Thu 11 Networking Guide - Thu 11:50 Meetup (Friday 14:00-17:30) Contributors meetup. No agenda. And a note for those who noticed the Ops guide omission: this should take place in the Ops track, and I'll let you know when that session will be. Lana -- Lana Brindley Technical Writer Rackspace Cloud Builders Australia http://lanabrindley.com signature.asc Description: OpenPGP digital 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] Our Install Guides Only Cover Defcore - What about big tent?
-BEGIN PGP SIGNED MESSAGE- Hash: SHA256 On 24/03/16 08:01, Doug Hellmann wrote: > Excerpts from Lana Brindley's message of 2016-03-24 07:14:35 +1000: >> Hi Mike, and sorry I missed you on IRC to discuss this there. That said, I >> think it's great that you took this to the mailing list, especially seeing >> the conversation that has ensued. >> >> More inline ... >> >> On 24/03/16 01:06, Mike Perez wrote: >>> Hey all, >>> >>> I've been talking to a variety of projects about lack of install guides. >>> This >>> came from me not having a great experience with trying out projects in the >>> big >>> tent. >>> >>> Projects like Manila have proposed install docs [1], but they were rejected >>> by the install docs team because it's not in defcore. One of Manila's goals >>> of >>> getting these docs accepted is to apply for the operators tag >>> ops:docs:install-guide [2] so that it helps their maturity level in the >>> project >>> navigator [3]. >>> >>> Adrian Otto expressed to me having the same issue for Magnum. I think it's >>> funny that a project that gets keynote time at the OpenStack conference >>> can't >>> be in the install docs personally. >>> >>> As seen from the Manila review [1], the install docs team is suggesting >>> these >>> to be put in their developer guide. >> >> As Steve pointed out, these now have solid plans to go in. That was because >> both projects opened a conversation with us and we worked with them over >> time to give them the docs they required. >> >>> >>> I don't think this is a great idea. Mainly because they are for developers, >>> operators aren't going to be looking in there for install information. Also >>> the >>> Developer doc page [4] even states "This page contains documentation for >>> Python >>> developers, who work on OpenStack itself". >> >> I agree, but it's a great place to start. In fact, I've just merged a change >> to the Docs Contributor Guide (on the back of a previous mailing list >> conversation) that explicitly states this: >> >> http://docs.openstack.org/contributor-guide/quickstart/new-projects.html > > I think you're missing that most of us are disagreeing that it is > a good place to start. It's fine to have the docs in a repository > managed by the project team. It's not good at all to publish them > under docs.o.o/developer because they are not for developers, and > so it's confusing. This is why we ended up with a different place > for release notes to be published, instead of just adding reno to > the existing developer documentation build, for example. > All docs need to be drafted somewhere. I don't care where that is, but make the suggestion of /developer because at least it's accessible there, and also because it's managed in the project's own repo. If you want to create a different place, or rename /developer to be more inclusive, I think that's a great idea. >> >>> >>> The install docs team doesn't want to be swamped with everyone in big tent >>> giving them their install docs, to be verified, and eventually likely to be >>> maintained by the install docs team. >> >> Which is exactly why we're very selective. Sadly, documenting every big tent >> project's install process is no small task. > > Right. The solution to that isn't to say "we aren't going to document > it at all" or "publish the documentation somewhere less ideal", > though, which is what it sounds like we're doing now. It's to say Actually, I said that I acknowledge that isn't working, and we need to find a different solution. > "you are going to have to manage that document yourself, with the > docs team answering some questions to get you started using standard > templates for the document and build jobs". We need a way for all > teams to publish things they write to locations outside of their > developer docs, without the documentation team feeling like they > are somehow responsible for the results (or, more importantly, for > readers of the documents to think that). Yes, which is exactly what we'll be discussing at Summit. > > I like the prominent "file a bug here" link on the new docs theme, > so if we could reuse that but point the URL to the project's launchpad > site instead of the documentation team's site, that would be a > start. We may be able to do other things with the theme to further > indicate who created the content and how to get help o
Re: [openstack-dev] [docs] Our Install Guides Only Cover Defcore - What about big tent?
-BEGIN PGP SIGNED MESSAGE- Hash: SHA256 Hi Mike, and sorry I missed you on IRC to discuss this there. That said, I think it's great that you took this to the mailing list, especially seeing the conversation that has ensued. More inline ... On 24/03/16 01:06, Mike Perez wrote: > Hey all, > > I've been talking to a variety of projects about lack of install guides. This > came from me not having a great experience with trying out projects in the big > tent. > > Projects like Manila have proposed install docs [1], but they were rejected > by the install docs team because it's not in defcore. One of Manila's goals of > getting these docs accepted is to apply for the operators tag > ops:docs:install-guide [2] so that it helps their maturity level in the > project > navigator [3]. > > Adrian Otto expressed to me having the same issue for Magnum. I think it's > funny that a project that gets keynote time at the OpenStack conference can't > be in the install docs personally. > > As seen from the Manila review [1], the install docs team is suggesting these > to be put in their developer guide. As Steve pointed out, these now have solid plans to go in. That was because both projects opened a conversation with us and we worked with them over time to give them the docs they required. > > I don't think this is a great idea. Mainly because they are for developers, > operators aren't going to be looking in there for install information. Also > the > Developer doc page [4] even states "This page contains documentation for > Python > developers, who work on OpenStack itself". I agree, but it's a great place to start. In fact, I've just merged a change to the Docs Contributor Guide (on the back of a previous mailing list conversation) that explicitly states this: http://docs.openstack.org/contributor-guide/quickstart/new-projects.html > > The install docs team doesn't want to be swamped with everyone in big tent > giving them their install docs, to be verified, and eventually likely to be > maintained by the install docs team. Which is exactly why we're very selective. Sadly, documenting every big tent project's install process is no small task. > > However, as an operator when I go docs.openstack.org under install guides, > I should know how to install any of the big tent projects. These are accepted > projects by the Technical Committee. > > Lets consider the bigger picture of things here. If we don't make this > information accessible, projects have poor adoption and get less feedback > because people can't attempt to install them to begin reporting bugs. I agree. This has been an issue for several cycles now, but with all our RST conversions now (mostly) behind us, I feel like we can dedicate the Newton cycle to improving how we do things. Exactly how that happens will need to be determined by the docs team in the Austin Design Summit, and I strongly suggest you intend to attend that session once we have it scheduled, as your voice is important in this conversation. Lana - -- 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/ iQEcBAEBCAAGBQJW8wc7AAoJELppzVb4+KUywYMIAMr78Gw+zPp3LXyqxkQFPs9y mo/GJrfQ9OLD6CXpKSxcmvnuaHP1vHRrXPqkE02zb6YTOxV3C3CIW7hf023Dihwa uED5kL7DrkTO+xFrjClkVRpKit/ghWQ3By/V9yaYjgWQvvRy3/Y+dvjZHnrDDHE1 rIxbU4PVZ0LPTxI7nNy71ffxFXW2Yn9Pl6EJnVm/iu9R+BNfRHgQ3kdqalG+Ppat 9tZIGpxzi5/dTS9dTf5zN2GqYzYoDR8J6C/O/ojWyOjwcycvqWH0XboV7usLLMR8 77RB/Ob8WszpbHZ6+yJF3P9hJhwhFXs8UJFcapkwaMy7wu8Lt0+etgC8nPDFj9I= =hsaE -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
[openstack-dev] What's Up, Doc? 18 March 2016
-BEGIN PGP SIGNED MESSAGE- Hash: SHA256 Hi everyone, It is with great pleasure that I announce that I will be the PTL again for Newton, which will be my third release for openstack-manuals. I'm overwhelmed by the positive messages I've received since announcing my candidacy, and very excited to be leading such a dedicated and innovative group into the fray again. This week I spent some time on the Contributor Guide, working with Brian to get the docs tools documented, which is something we've been wanting to do for some time. Very soon I'll be calling for your ideas on Summit sessions, and beginning to do Design Summit planning. The Install Guide is now in the last push to have everything tested before release, but we can still use your help getting it all done! If you can help, please contact Matt Kassawara, or any docs core. == Progress towards Mitaka == 19 days to go! 515 bugs closed so far for this release. Docs Testing * Volunteers required! * https://wiki.openstack.org/wiki/Documentation/MitakaDocTesting Release Tasks: * Release planning occurs in our etherpad here: https://etherpad.openstack.org/p/MitakaRelease * We're now freezing larger changes to the Install Guide, so cores will not be merging anything that changes the architecture of the guide, or significantly changes the technical content (except where that change is as a result of testing). This is to make the Install Guide testers work a little easier, by stopping the book from moving too much from under them. * We will be publishing release notes for our own projects to == Docs-tools == * Andreas and team have released a new version of the docs theme, which removes the versions information from the sidebar, and also removes the duplicated titles. This should make navigating the CI guides much easier, and reduce confusion over versions. == The Road to Austin == * PTL elections are now open for those projects that have more than one candidate. You should have received an email for elections in which you are eligible to vote. * I am pleased to announce that I am remaining as docs PTL for Newton (elected unopposed). I would also like to congratulate KATO Tomoyuki on becoming the new PTL for i18n, and to thank Daisy for her hard work in that group for many releases. * I have requested workrooms and fishbowls for the Austin Design Summit. I'll let you know when we get our allocation. I will send out a note next week to start gathering your ideas for sessions. == Speciality Teams == '''HA Guide - Bogdan Dobrelya''' New for Mitaka release notes: Improved Pacemaker/Corosync cluster installation and configuration details http://docs.openstack.org/ha-guide/controller-ha-pacemaker.html (kudos Andrew Beekhof). Pacemaker Cluster Manager http://docs.openstack.org/ha-guide/intro-ha-arch-pacemaker.html and Keepalived http://docs.openstack.org/ha-guide/intro-ha-arch-keepalived.html architecture details and limitations (kudos Andrew Beekhof). Detailed Mariadb/Galera cluster installation, configuration and management guide http://docs.openstack.org/ha-guide/controller-ha-galera.html (kudos Kenneth Dyer). Improved RabbitMQ clustering guide http://docs.openstack.org/ha-guide/controller-ha-rabbitmq.html - HAProxy antipattern explained, new A/A option with Pacemaker resource agents (kudos KATO Tomoyuki, Andrew Beekhof). Many more, so read everything carefully ;-) '''User Guides - Joseph Robinson''' Larger patch for editing submitted this week, and working within the user guide team to reorganize the command line content in the admin user guide by moving common files into the cloud admin guide. '''API Docs - Anne Gentle''' Swagger files now built to developer.openstack.org. Project teams have templates for writing API guides within their project repository . == Doc team meeting == Next meetings: No meeting was held this week. Next meetings: APAC: Wednesday 23 March, 00:30 UTC US: Wednesday 30 March, 19:00 UTC Please go ahead and add any agenda items to the meeting page here: https://wiki.openstack.org/wiki/Meetings/DocTeamMeeting#Agenda_for_next_meeting - -- Keep on doc'ing! Lana https://wiki.openstack.org/wiki/Documentation/WhatsUpDoc#18_March_2016 - -- 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/ iQEcBAEBCAAGBQJW642DAAoJELppzVb4+KUyfDcIAMpfegqx4dfyFCbK2LzhBzT0 Ky9CVUCzKJQGdZQVCGcfJZRJI3OtLXfWMKrkx5v5pE6lw0UJ1a8RfR8/46weUn1v wlC9k95RLeff64Wa16AE6YQc6oXEhsGWWciptgeTmg2aeWJfax7S1wx2F8UhF419 FM4iFr/PhvyrVs4BXeyx6l3LLRFfSWo/YiyEHDUOAPOQMJ0N/gZaOL5ir+fASEwl xSXbb9fzdVfhrJivnPOrxYoZBSivTSlIn4xWmGsMaoCUzV2xrQmwCWRV07TVneYp nthofj01Ij3kNWv2Gm3XrIkJFkHX7OG0+tlxPs3CUm2bguzQlpND45I/ILv8TbE= =GmrT -END PGP SIGNATURE- __ OpenStack Development Mailing List
[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
[openstack-dev] What's Up, Doc? 11 March 2016
://wiki.openstack.org/wiki/Documentation/WhatsUpDoc#11_March_2016 - -- 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/ iQEcBAEBCAAGBQJW4kjpAAoJELppzVb4+KUyUSEH/iBWAOfRKZd8xEjUUh6roBPY XMeQh13RTBLBftyQoyzgIDenWfnaUeCrcDWlyNdY3jOVsDVQF9q0AkvuuzqXrfUu /LsnqcSHwJO0ervp6z7d0iJ0droUnJf0Qf3h1MMwutcwynRJtHVOsUYMVTLG9Dcw wALqlmxFwukD3GrbQfZ1M8MDGwVMopWU9/GsFNlHnBnbJ6DQFLBylWzGPEUQFR3e x/HAEC/ofNANZ5GqUTroqArNbv12bOTQanBGzIpcqEJ3hNG1c9tUMA3xH8ygLdCG cRoeDA4sCheYn8LWr1eNnw1jx4CAjUiO7d91Tf12c7Wp8XhMSquU18JzZ+g6Rkc= =lGay -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] some error of install-openstack-from-source
-BEGIN PGP SIGNED MESSAGE- Hash: SHA256 On 09/03/16 08:56, Tony Breeds wrote: > On Tue, Mar 08, 2016 at 10:41:49AM +0800, yewgang wrote: >> Hi, >> >> I'm porting openstack from source into my environment, follows >> https://developer.rackspace.com/blog/install-openstack-from-source/ >> >> I found the script in "Create the various users and directories needed for >> the OpenStack services." has some error as follow: >> >> 1. miss "done" at the end of this script. >> 2. we have to run this script using "bash", not "sh". > > Thanks for the report. That's a rackspace blog and not something in the > control of the OpenStack community. Fortunately we happen to overlap > somewhat. > I've CC'd Lana who has access to those systems and *may* be able to make > corrections. > Just for the record (my other email address isn't subscribed to this list): I've gotten on to Phil Hopkins, the original author. He's preparing to update the post for Liberty, and will fix this at the same time. Thanks for the heads up :) L - -- 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/ iQEcBAEBCAAGBQJW31zfAAoJELppzVb4+KUyFtAH/iIurwI+XJpNznMh4FApeJr/ ZnhdkkRjHVmXwFHkz+jJmSNSCOb3//PwvFTytcEcBy/JW0p9bl50CY2wlzCF1OVi 570fce9xBtAKD2fJoNcxFXutMP4mRaae6GUhKF3MK4LZkILQ2fgRQjGMzDCRJvLc iJweTY8LYygoaiVose15f4mllC0XBH9E8AxF/lO2PXvzXdrAtJHbCabCP3Mx3b5s DgVTh6CGTTmmh8daTsCxsWlMFrX8lJRszirzEvdBf99dCCr/DwRKmyzVsbVnehh9 UEQevOcrcrE5CIjivRnokIKI85sJCSfdnWqPRR2BDqnNQKXfPUYBuP7VwVTarVQ= =/yHB -END PGP SIGNATURE- ___ Mailing list: http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack Post to : openstack@lists.openstack.org Unsubscribe : http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack
Re: [openstack-dev] [OpenStack-docs] Fwd: [Neutron][LBaaS][Octavia][Docs] Need experienced contributor documentation best-practices and how-tos
-BEGIN PGP SIGNED MESSAGE- Hash: SHA256 On 08/03/16 02:09, Hayes, Graham wrote: > On 07/03/2016 16:00, Matt Kassawara wrote: >> Snipping a lot, because I'm particularly interested in one comment... >> >> >> I agree that many developers (especially developers of those groups >> new to the big tent) seem to think that they need to be on the top >> level docs.openstack.org <http://docs.openstack.org>, without >> necessarily understanding that docs.openstack.org/developer >> <http://docs.openstack.org/developer> is usually the more >> appropriate place, at least to begin with. This should probably be >> made more explicit both in the Infra Manual, plus anywhere that >> Foundation is discussing big tent inclusion. >> >> >> We tell operators and users to look at the documentation on >> docs.openstack.org <http://docs.openstack.org> because the documentation >> in /developer is aimed at developers and often lacks polish. Now we're >> telling developers to put operator/user documentation into /developer? > > To follow up on that - the Foundations "Project Navigator" has one of > the maturity requirements as "Is there an install guide for this > project guide (at docs.openstack.org)?" > > If this is required, how can projects get content in to this. > > I went looking about 6 months ago for the information that Stephen > asked for to update (create) our docs, but couldn't find it. > To try and answer both questions in one reply: The developer documentation should live on /developer, with config options automatically picked up for the Config Reference where appropriate. If you are new to the big tent, then you should also use /developer to create and polish your user documentation. This is enough to be considered 'official' according to the Project Navigator. Once you have a good amount of quality content, then please feel free to open a conversation with docs about inclusion in the top level. The main reason we do it this way is because writing docs is a very manual, labour-intensive task, and the docs team is small. We already have a lot of content that we maintain and a lot of people throwing things over the wall to us. We simply cannot have every big tent project present in the Install Guide. Hope that helps clear things up. Lana - -- 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/ iQEcBAEBCAAGBQJW3gf/AAoJELppzVb4+KUygvgH/3CLosJOZQ4HOGzZ6gyESAip 7gxKSNRaN9LTVXGUFMpSwppDMPguM2X78bpQB1cSa6A20mvRHbHKVFtio/virn1l 05R0iWRR5I157ggfVFA8P+tLeVONVTQi0Sa9W/L6GU/Ihr7mplVptYz5tpipmJy9 RYwa3LlOCF1qMQogOdNcv+5Tg2ci6Sqn03xw43jN18iC2dAtJVZJxmjO760mJ9h9 9uLDpb8GOvrCNvM4hdiWoZlEIbYpViaZGcYqQElml1RqZOmzswC1GOrquGIENkTl eClj7UFUUji0/6WqeoDjSq/60NzT/i+IYvBd0bFDPgmn2kZLt67xCgoyfrj1Cik= =AfBL -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] Octavia configuration options were deleted but needed for Mitaka
-BEGIN PGP SIGNED MESSAGE- Hash: SHA256 Hi Michael, Thanks for this. I'm looking into it now and will get back to you on next steps. Lana On 04/03/16 05:57, Michael Johnson wrote: > This is in reference to bug: > > https://bugs.launchpad.net/openstack-manuals/+bug/1552797 > > The liberty documentation set has the octavia.conf section: > http://docs.openstack.org/liberty/config-reference/content/networking-plugin-lbaas.html > > The current Mitaka documentation does not have an octavia.conf section: > http://docs.openstack.org/draft/config-reference/networking/networking_options_reference.html > > It appears that the octavia.conf settings documentation was deleted > from the Mitaka docs here: > https://review.openstack.org/#/c/259889 > > It has been pointed out that this was due to this e-mail chain: > http://lists.openstack.org/pipermail/openstack-docs/2015-December/008026.html > > That said, Octavia is the reference driver implementation for > neutron-lbaas and it is important that we continue to provide > documentation for users of neutron-lbaas. Armando is asking us to > update this documentation for the Mitaka release, but we are unable to > do so. > > Can someone help me with instructions on what I need to do to restore > this documentation for the Mitaka release? > > I am not familiar with the xml->rst changes that have occurred so I > need some help. > > In the docs channel and on the bug I have had advice to use pandoc to > convert the liberty xml to rst and check it in. This does not seem > right as the other files say they are auto-generated. > > I'm just looking for a way to get this restored so we can update them > for the Mitaka release. > > Thanks, > Michael > > __ > 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 > - -- 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/ iQEcBAEBCAAGBQJW3NUDAAoJELppzVb4+KUy46gIAIo9DTgXYv912tPxdL/d3Bwq cfeYvr3Q0YRjD+HSX3AUuydtT8+awBTiPBeymkNqGuaeL4vkf+VgjifyoNrAnhoM RBK8pk4QwajIqT/cr12jRxuATRGTfgWwB0KA8pSXax5t3QtTcesS4c0Vafx+TDNV yrMaaeMLz8G7M3+DzxIXVObXUgABanRPH5H3IbKCW+KJ/I1cWZOGfk6A4mvkLENY 9yuKGnuLEG3gck1660QSGHMLK+bIglCZ2yJm9PScGqLnCx8oiuJmSGhQerPJ3c2W phIMnw00URgJY9THPCyKdtNI6mOdvMYzfMj0y9rxANvp0Gzr5S3ztf40xyvh6wY= =EgmZ -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] [OpenStack-docs] Fwd: [Neutron][LBaaS][Octavia][Docs] Need experienced contributor documentation best-practices and how-tos
t which > point we thought we'd have to get it all into the manual somehow). > > What I'd like to see on this front is some kind of opinionated guide on the > best way to organize where documentation should go within a project, as > well as recommendations for which tests should be set up for the same. Of > course this won't be appropriate for every project (hence "opinionated > guide"), but it seems to me that it would be helpful to project cores to > have such a thing-- and would likely aid with automation and consistency of > documentation across the umbrella of OpenStack projects. I agree that many developers (especially developers of those groups new to the big tent) seem to think that they need to be on the top level docs.openstack.org, without necessarily understanding that docs.openstack.org/developer is usually the more appropriate place, at least to begin with. This should probably be made more explicit both in the Infra Manual, plus anywhere that Foundation is discussing big tent inclusion. > > In addition to this, I also don't find any good guideline in the > documentation contributors' guide as to what kind of documentation is > appropriate for the openstack manual, and which should go elsewhere. I > realize this is also very much a judgement call-- but that's why I'd call > it an "informed opinion." > > Again, what I'm asking for here is an codified informed opinion (which is > really all a "best practices" guide is). No strict enforcement of policy > (unless the individual project cores want to do that), per se: Just > guidelines y'all think that project cores should be following regarding the > treatment of documentation within and without the OpenStack manual. We are > more experienced than we were back then, but I suspect that even very > mature projects could benefit from this guide (especially if best practices > change, or as there is turnover in cores). Having that added to the > documentation contributors' guideline would be very helpful, in my opinion! > I agree. As I mentioned earlier, I'll propose a patch to the Contributor's Guide, to hopefully make this more explicit. > >> > > I agree that handling docs like code is a good thing. Maybe adding the > "Doc-Change:" feature described above could aid in that. :) > > Perhaps part of the problem is that the contributors' guide has only one > "Quickstart" page, that is aimed purely at people new to OpenStack > contribution in general. Perhaps it would be a good thing to create two > more quickstart pages: One aimed at experienced contributors who > nevertheless don't do (or haven't done) documentation updates that often, > and another aimed at project cores which list best practices for where > different types of documentation should go, as well as best practices for > how to organize and test documentation kept within their own repositories > (even if half of this just ends up being links to infra docs)? > > Part of the problem with the contributors' guide as I see it right now is > that it provides a lot of detail on specific items, but it's easy to get > quickly overloaded in detail. The detail is definitely important, but > without knowing where to get started, it can become frustrating (and people > will give up-- even people who have otherwise work with gerrit every day.) > > Does that make sense? > Absolutely. Thank you. > >> >> Your automated content should be here: >> http://docs.openstack.org/liberty/config-reference/content/networking-plugin-lbaas.html >> Please raise a bug against openstack-manuals ( >> https://launchpad.net/openstack-manuals) if that is not the case. >> >> > Ok, I will do what I can to galvanize my team to make the above not suck. > :) Given our previous discussion, I don't suppose there's an obvious way to > figure out where a relatively new project's information ought to be > inserted in the manual? (Octavia is the reference implementation for > Neutron-LBaaS, so in the operators' guide on how to set up LBaaS we're also > going to have to describe how to set up, configure and maintain Octavia.) I'll go out on a limb here, and suggest that maybe you need to consider some addition to the Networking Guide (http://docs.openstack.org/liberty/networking-guide/). > > >> Octavia is documented here: http://docs.openstack.org/developer/octavia/ >> If you have content to add, propose a patch to >> http://git.openstack.org/cgit/openstack/octavia >> >> > Yep-- contributed a good portion of that myself already, actually. :) > (Didn't know that was "kosher.") > This is a really great start, and it's also a good way to draft pieces that y
[openstack-dev] What's Up, Doc? 4 March 2016
ttps://wiki.openstack.org/wiki/Documentation/MeetingLogs#2016-03-02 Next meetings: APAC: Wednesday 9 March, 00:30 UTC US: Wednesday 16 March, 19:00 UTC ***Note the new time!*** Please go ahead and add any agenda items to the meeting page here: https://wiki.openstack.org/wiki/Meetings/DocTeamMeeting#Agenda_for_next_meeting - -- Keep on doc'ing! Lana https://wiki.openstack.org/wiki/Documentation/WhatsUpDoc#4_March_2016 - -- 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/ iQEcBAEBCAAGBQJW2RKeAAoJELppzVb4+KUyiVEH/ROrKbQvJ3VEr1jVMNn5g16O aFu2aNjEd3cOJ50FHkzi0NdsHJoNslFq6NpSEcWdFQihKh5anZeaFA8flO8bKA/L xepUnQjTvcgvZgiREutcQGkowaIqZiUxkXr8YV36So+K8CQwyHOcBfBlcR8hSMRa r2k0o+BA2GjBZuAvjt4P6eIfCNrAA8N2oycXTU0F2j6IIwDoQ23A8uyTuKHrBArQ 8FYeUv31fabqA+jsRZRpYr2QinpyRW+m1xbeYsnh3cXq9QciwEqbdC44d/+MZsJq dOTI2MeUmCKz72Y7ftwPXGuyKcv84RNe/FSRoZWgCdIK3RSdChD/IVoiHtRbtUo= =+XXP -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] [OpenStack-docs] Fwd: [Neutron][LBaaS][Octavia][Docs] Need experienced contributor documentation best-practices and how-tos
no idea how I go about updating the manual for the major > features that we added to neutron-lbaas and Octavia in this cycle. Your automated content should be here: http://docs.openstack.org/liberty/config-reference/content/networking-plugin-lbaas.html Please raise a bug against openstack-manuals (https://launchpad.net/openstack-manuals) if that is not the case. Octavia is documented here: http://docs.openstack.org/developer/octavia/ If you have content to add, propose a patch to http://git.openstack.org/cgit/openstack/octavia If you feel these things should be documented elsewhere, please raise a bug, or ping me on IRC (I'm loquacity) and we can chat further about the best place for it. Thanks for all the feedback. Lana - -- 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/ iQEcBAEBCAAGBQJW2PXCAAoJELppzVb4+KUyom0IAJndII3lSDmynkb0EIS+r4+0 JaT/u9+a/Y/KDuzzr/C0bfVQQZqIv9E9BllvRbgcrt4ZtoTyCKJTe7bHoeuE0Rd1 69VSPsL7Gx/9irz9YjINTS2vYWZQNpmC8MIvpU9rxf27A3OZOlF2iF5/RoWxonjr rL1XlOKo9Uj08+Pwc5DIHT46iE7hD7w4PQVLOaC9R5b0s7IpWgeG2rGVakalrLff IM+BBwEmELXbLvWCelr1OmU1pZjXhsLwZp0yZT0xVhFWGJ3v+zqMYqLVBPVSD4Ez s+Ai8zuqz2H1wVhe0mKUBu4iZLVJm4tswh+sEXsZYxuuRrpNWakUbqbmb/KhRI4= =Caqi -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
[openstack-dev] What's Up, Doc? 26 Feb 2016
meetings: The APAC meeting attempted to be held this week, but failed to meet quorum. Next meetings: US: Wednesday 2 March, 19:00 UTC ***Note the new time!*** APAC: Wednesday 9 March, 00:30 UTC Please go ahead and add any agenda items to the meeting page here: https://wiki.openstack.org/wiki/Meetings/DocTeamMeeting#Agenda_for_next_meeting - -- Keep on doc'ing! Lana https://wiki.openstack.org/wiki/Documentation/WhatsUpDoc#26_February_2016 - -- 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/ iQEcBAEBCAAGBQJWz9fuAAoJELppzVb4+KUycvYIAJcS46IEaJ10izihei5rFTC3 Y90og8sCTOBTtD36L/la4EQEb33gEzozvOfJlN+nXBbyI1J85q5Bbaxhvmt6WgVy 8lS7hGS8RD74caYM2Hyfby8LHfNXlnXDO9NKGBy10RCqsLMw5sgcNcnA0r5IcwVx OrWOSMwcA/T0oJybSeKrgnaUDwXFwaPpZP4LGGblJrw2+WI7TamxgYEBYG5fumWo FVyAaswBdu1+zA+bCN6KwtbhfbM0VYpQeAuafE8GMYXqeiuVdvTu67z4S4bQUnR2 1JsADOBi77i7AyzP9OknvcGTjxuwXzWopvSi01si16mzQ1CAtdimDej4lyaSJ1Q= =DM9Z -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
[openstack-dev] What's Up, Doc? 19 Feb 2016
that covers icons and text formatting. If interested or have questions, contact Linette or Piet Kruithof. == Doc team meeting == Next meetings: The US meeting was held this week, you can read the minutes here: https://wiki.openstack.org/wiki/Documentation/MeetingLogs#2016-02-14 Next meetings: APAC: Wednesday 24 February, 00:30 UTC US: Wednesday 2 March, 14:00 UTC Please go ahead and add any agenda items to the meeting page here: https://wiki.openstack.org/wiki/Meetings/DocTeamMeeting#Agenda_for_next_meeting Note that there is currently discussion about moving the US meeting to 20:00 UTC. A patch is open to change this, with ongoing discussion about finding a meeting room: https://review.openstack.org/#/c/271361/ - -- Keep on doc'ing! Lana https://wiki.openstack.org/wiki/Documentation/WhatsUpDoc#19_February_2016 - -- 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/ iQEcBAEBCAAGBQJWxpUQAAoJELppzVb4+KUyM5IIAKXT4U1SDq8K1+3u41qchjRe tXx3DCHp+O70krBFP+b6xaYXsuIwd6G4iroUXtl0RodlNAxdBjFf82fnpTlt/sz9 tjlST4nt/Z93shaA5b0AkOzEKJhoHCyH0ucq2GCQ81P5mEM3ZkFOYsEjdQjckPhu fc8yvbgjo1Dvxjk6/bEV6c1hroEqLVrzhpd9jstefA/1ATTCg3hR/IWQ9cXscMn0 8qutBYibhFcXzcCVj4/aafjUH+1punMgGeb2KcjrmA0z345WcmS4+IWR4NZrCiMg WWEKbFT8MvGuLEU79KNs+cZBWA+TQnlD2d1fsuCHFKU/eqFeyPmc3P/tI9YM7Jo= =2AkG -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
[openstack-dev] What's Up Doc? 12 Feb 2016
-BEGIN PGP SIGNED MESSAGE- Hash: SHA256 Hi everyone, This week has been all about the Install Guide. We're locating pre-release packages now so we can begin testing in about two weeks' time. Please consider being a tester for this release. Even if you've never done it before, it's a great way to improve your OpenStack knowledge, and the more people we have testing, the better and more accurate our docs will be, which helps everyone. We're also starting to see a little more action in the lead up to the Austin Summit. ATC passes are going out, and the talk sessions are now open for voting: https://www.openstack.org/summit/austin-2016/vote-for-speakers/ == Progress towards Mitaka == 54 days to go! 389 bugs closed so far for this release. Docs Testing * Volunteers required! * https://wiki.openstack.org/wiki/Documentation/MitakaDocTesting RST Conversions * All planned RST conversions are now complete! Reorganisations * Arch Guide: really needs a last minute push to get this complete before Mitaka. If you can help out, it would be greatly appreciated! ** https://blueprints.launchpad.net/openstack-manuals/+spec/archguide-mitaka-reorg ** Contact the Ops Guide Speciality team: https://wiki.openstack.org/wiki/Documentation/OpsGuide * User Guides ** https://blueprints.launchpad.net/openstack-manuals/+spec/user-guides-reorganised ** Contact the User Guide Speciality team: https://wiki.openstack.org/wiki/User_Guides DocImpact * Is now complete == The Road to Austin == * ATC passes are going out now, so keep an eye on your inbox for your discount code if you haven't received yours yet. * Don't forget to vote on your favourite talks: https://www.openstack.org/summit/austin-2016/vote-for-speakers/ == Speciality Teams == '''HA Guide - Bogdan Dobrelya''' Minor updates to the corosync/pacemaker, rabbitmq clusters setup guides '''Installation Guide - Christian Berendt''' Mitaka Installation guide changes spec: https://review.openstack.org/#/c/274231/ Testing beginning, require packages: https://wiki.openstack.org/wiki/Documentation/MitakaDocTesting '''Networking Guide - Edgar Magana''' Move the IRC meeting agenda to etherpad: https://etherpad.openstack.org/p/docnetworkingteam-agenda. Important Commits: DSCP addition to advanced qos guide: https://review.openstack.org/#/c/273638/ Add networking guide to Contributors Section: https://review.openstack.org/#/c/278330/ Last IRC Meeting Notes: http://eavesdrop.openstack.org/meetings/networking_guide/2016/networking_guide.2016-02-04-16.02.log.html '''Security Guide - Nathaniel Dillon''' Continuing bugfixes and beginning Networking review (thanks to all Neutron contributors!) '''User Guides - Joseph Robinson''' Held First US/EU Meeting, which was 1 and a 1/2 hours before the APAC meeting (Need to reserve the meeting time). Discussed Reorg- High Priority step - moving Dashboard content from the Admin Guide to the Cloud Admin Dashboard Chapter. '''Ops and Arch Guides - Shilla Saebi''' Architecture guide reorganization is underway. We have a drafts repo in openstack-manuals, feel free to ping Shilla or Darren Chan if you are interested in helping out. Considering doing a swarm or work session at the summit in Austin for the Arch guide. Operations guide RST migration pending - conversations still happening to see which route we'll take. Still deciding if the ops guide should have another revision or edition, see ML emails. '''API Docs - Anne Gentle''' No update this week. '''Config Ref - Gauvain Pocentek''' No update this week. '''Training labs - Pranav Salunke, Roger Luethi''' We reviewed and merged several patches: bug fixes, refactoring and some code to help with debugging. '''Training Guides - Matjaz Pancur''' No update this week. '''Hypervisor Tuning Guide - Joe Topjian''' No update this week. '''UX/UI Docs Guidelines - Linette Williams''' No update this week. == Doc team meeting == Next meetings: The APAC meeting was held this week, you can read the minutes here: https://wiki.openstack.org/wiki/Documentation/MeetingLogs#2016-02-10 Next meetings: US: Wednesday 17 February, 14:00 UTC APAC: Wednesday 24 February, 00:30 UTC Please go ahead and add any agenda items to the meeting page here: https://wiki.openstack.org/wiki/Meetings/DocTeamMeeting#Agenda_for_next_meeting Note that there is currently discussion about moving the US meeting to 20:00 UTC. A patch is open to change this, with ongoing discussion about finding a meeting room: https://review.openstack.org/#/c/271361/ - -- Keep on doc'ing! Lana https://wiki.openstack.org/wiki/Documentation/WhatsUpDoc#12_February_2016 - -- 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/ iQEcBAEBCAAGBQJWvWWOAAoJELppzVb4+KUyadwIAIzWAp7pJChEUmd6joi4GHig OLuvC3nsD6NnjW4qtK6OHdPklZQ6nN8JgNGhbnbBWhmO6/Pk4ulk4TUl5ENtYPxJ
[openstack-dev] What's Up, Doc? 6 Feb 2016
that there is currently discussion about moving the US meeting to 20:00 UTC. A patch is open to change this, with ongoing discussion about finding a meeting room: https://review.openstack.org/#/c/271361/ - -- Keep on doc'ing! Lana https://wiki.openstack.org/wiki/Documentation/WhatsUpDoc#6_February_2016 - -- 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/ iQEcBAEBCAAGBQJWtXI/AAoJELppzVb4+KUy1j8IAJ+g5ZbNQuvDCJsznis2EgfX TDMxpovMVwULypjuQdqLT7K6C/uy/4dZbKSlG7vsENnE/dzJngn52P5DriFN3CV0 YjJQ+c7iTzOaiI4choz2sdoaKOYvLIdwDSg89FpS+AE3QF0e3FnjqCtLnRJJAZhN eBg1EaTIeQO9Hz4VWs6QBIMZPsYB7icONy9V08IKDu5HyRm5HFJy73g1Wp+Nrrlv cE5PyBnARBES4bBocxENBy1w7/Pl1exnZXS7M/gadAsJGXBt/k77Ec+6wgY4BmaL XWMyjYGb+LEkdebcKf+kEZ+88eEJlTteSZgvr4B8PdDoB2b3kNUVG3tAuW3/q3g= =fQ5W -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
[openstack-dev] [Doc] Further DocImpact Changes
-BEGIN PGP SIGNED MESSAGE- Hash: SHA256 Hi everyone, TL;DR: DocImpact is changing, again, please review 276065 Some time ago, docs implemented a blueprint[1] to modify the behaviour of the DocImpact script. The agreed change was that all projects *with the exception of the five defcore projects* would have DocImpact bugs raised in their own repo. In other words, docs were anticipating continuing to handle DocImpact bugs for Nova, Glance, Swift, Keystone, and Cinder, but no other projects. In order to make this triaging process easier, we also wanted to enforce a description when DocImpact was used in a commit message. However, upon implementing this in Nova, as a trial, we discovered that it had a non-trivial impact on processing times, and the change was reverted[2]. After some discussion, we agreed[3] to try just resetting DocImpact to the individual groups, *including* the five defcore projects. This eliminates the need the run a check on the commit message for a description, as we're moving the burden of triage away from the docs team, and into the individual project teams. One of the ben e fits of this change is that all product groups can now use DocImpact in a way that best suits their individual needs, rather than being tied to what Docs expects. I've now gotten in-principle approval from each of the PTLs affected by this change, but wanted to ensure everyone had a chance to go over the new patch[4], and discuss these changes. This is, as always, a reversible decision. If this solution happens to fall in a heap, I'm willing to try something different :) Cheers, Lana 1: http://specs.openstack.org/openstack/docs-specs/specs/mitaka/review-docimpact.html 2: https://review.openstack.org/#/c/259569/ 3: http://lists.openstack.org/pipermail/openstack-dev/2016-January/083806.html 4: https://review.openstack.org/#/c/276065/ - -- 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/ iQEcBAEBCAAGBQJWsviTAAoJELppzVb4+KUyz2EH/0IDHPOYzxjaypoJfFF7SopZ fZLvGZ0EgcIZc39582N38BUW8INFTFG90YrqPbaaPSF0Ri0HBLcs9PuosUaoaQYe BPe38zm11k5V8rQG6r7WA7vhMsTvHRhNNQpZ89cWkYMWLkFVDYA6LoKN+5RjDeEB wCpb+4zef2L22UKffaxEZ2bCUYXMx1LCppMN2EFhDou9blZ1yBtAYqS9wPPuUzVB DbSuRlZ6TMHiVntpJ1X/E8/PpErtaMkd3HPnbz3Ag2oT9O1qqdLCFdDkPaGsnkfJ aEtPjpdgeDfSVJW5UEJLJdeGhqY7aOtVq/3suLKWf+D/UzY/YBLWHMYacDjabPE= =0uUc -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
[openstack-dev] What's Up, Doc? 29 January 2016
-BEGIN PGP SIGNED MESSAGE- Hash: SHA256 Hi everyone, An incredibly hot week here in the antipodes, coupled with Australia Day has meant that I haven't been particularly productive this week. Luckily, the rest of you have picked up the slack, and things have been ticking along nicely. Thanks everyone :) == Progress towards Mitaka == 68 days to go! 368 bugs closed so far for this release. RST Conversions * All planned RST conversions are now complete! Reorganisations * Arch Guide ** https://blueprints.launchpad.net/openstack-manuals/+spec/archguide-mitaka-reorg ** Contact the Ops Guide Speciality team: https://wiki.openstack.org/wiki/Documentation/OpsGuide * User Guides ** https://blueprints.launchpad.net/openstack-manuals/+spec/user-guides-reorganised ** Contact the User Guide Speciality team: https://wiki.openstack.org/wiki/User_Guides DocImpact * After some discussion on the dev list, we're adjusting our approach to this problem. Watch this space. == Speciality Teams == '''HA Guide - Bogdan Dobrelya''' No update this week. '''Installation Guide - Christian Berendt''' AODH install instructions merged '''Networking Guide - Edgar Magana''' Networking guide versioning has been completed, we are publishing Liberty and Mitaka releases. Networking guide ToC has been updated and missing chapter have been assigned. Etherpad with the topic missing from the guide: https://etherpad.openstack.org/p/networking-guide '''Security Guide - Nathaniel Dillon''' No update this week. '''User Guides - Joseph Robinson''' Team meetings started again this week, and the large point was an IA reorg after content merging. Other discussion point included checking in with Docs liasons for Sahara, Trove, Murano, and Magneto plus checking in with interested volunteers for the User Guide Team. '''Ops and Arch Guides - Shilla Saebi''' Reorganization of the architecture guide is on-going. We have a full team of volunteers on our wiki <https://wiki.openstack.org/wiki/Documentation/OpsGuide>, but not much traction. We need more volunteers and we were looking to do a swarm in Manchester but not enough team members attending. Looking to maybe set one up for Austin. '''API Docs - Anne Gentle''' No update this week. '''Config Ref - Gauvain Pocentek''' No update this week. '''Training labs - Pranav Salunke, Roger Luethi''' Liberty support continues to make good progress. We can now launch an instance VM. Some clean up and reviewing still needs to be done. '''Training Guides - Matjaz Pancur''' Preparations for Austin Upstream training (https://review.openstack.org/#/c/271006/). New landing page for Training guides (http://docs.openstack.org/draft/training-guides/. '''Hypervisor Tuning Guide - Joe Topjian''' An update to to the Guide was posted back in December with a call for participation: http://lists.openstack.org/pipermail/openstack-operators/2015-December/009147.html == Doc team meeting == Next meetings: US: Wednesday 3 February, 14:00 UTC APAC: Wednesday 10 February, 00:30 UTC Please go ahead and add any agenda items to the meeting page here: https://wiki.openstack.org/wiki/Meetings/DocTeamMeeting#Agenda_for_next_meeting Note that there is currently discussion about moving the US meeting four hours later to 20:00 UTC. If you have a strong opinion on this matter, make sure you weigh in on the mailing list thread: http://lists.openstack.org/pipermail/openstack-docs/2016-January/008206.html - -- Keep on doc'ing! Lana - -- 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/ iQEcBAEBCAAGBQJWquVYAAoJELppzVb4+KUyBTQH/0M+ixT7g/MIePoZpFms5aSU SvLV/rAJe1dKbB2tNfq5ozNcWS/uMHB+w4bzHGjP+xexOvTUZNoBrKGLcufADMSS ekOMITnr69PLlXh5e+/G55/02sZUFmmq4ZC2xmDrgGbwZLohbLUA/L1G3o+oJGYy 2/KrNAQCutkEKTNwAN4NkA+cbSj8jM8UyVWfFzfEbywSmpmrrQyetEhfmZPj3g9t 7cUnqrRegHI7mwPGeLyM3O2bIj3CLKsmWDFEfzOfoUGDGDCQ6yGj8iv8u4PuA6Zt Mw041/PII0LWDCSvovYnsRoZXMcRGVFfWdBvrOVZaGZfVhZLK/2BrZPIr+r6EzA= =eKF8 -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
[openstack-dev] What's Up, Doc? 22 January 2016
the team on the usual docs mailing list, or ping any of us on IRC. == Doc team meeting == The US team meeting was held last week, you can read the minutes here: https://wiki.openstack.org/wiki/Documentation/MeetingLogs#2016-01-20 Next meetings: APAC: Wednesday 27 January, 00:30 UTC US: Wednesday 3 February, 14:00 UTC Please go ahead and add any agenda items to the meeting page here: https://wiki.openstack.org/wiki/Meetings/DocTeamMeeting#Agenda_for_next_meeting Note that there is currently discussion about moving the US meeting four hours later to 20:00 UTC. If you have a strong opinion on this matter, make sure you weigh in on the mailing list thread: http://lists.openstack.org/pipermail/openstack-docs/2016-January/008206.html - -- Keep on doc'ing! Lana - -- 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/ iQEcBAEBCAAGBQJWoafKAAoJELppzVb4+KUyFR8H/1so79V/BvFSAehklcbyDmZG JYkHQwrMUiTREN0y4l2ccegtgYWKeXEd01holKTMxxzR1KAcibi2eBMGjizNbIdt L8Add2BIPB8zwlqR0zrBAVKzecUth4EpvWLBTU4UDuHIHoF6cyOL3RZWKmkEg7/o GD7H/Yt264qFFPmQ8t8Flq5mUE892s2aReDVFkXPmmkNzBtIGDmzu13P6Y5zX4YX xzUSWJmBDTJPaz/0IsG8Sc46R3gs15hV7wtcCPwVtQXVZ18mKkYYz02zKQzpW518 Z8ysKgwHYkRhn+cxgsg10bV8/NePyxvgvHnknTLpbBZOV700kCmSTEmP3V3LUQw= =6VAi -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
[openstack-dev] What's Up, Doc? 15 January
-BEGIN PGP SIGNED MESSAGE- Hash: SHA256 Hi everyone, Welcome to 2016! A short newsletter this week as I get my feet back under me after my vacation. I hope you all had a wonderful holiday period, and got some well-earned down time. I'm looking forward to working hard with you all over the next few months to get Mitaka out into the wild :) == Progress towards Mitaka == 82 days to go! 324 bugs closed so far for this release. RST Conversions * All RST conversions are now complete! Well done to all the contributors and reviewers who made this happen so quickly this time around. We are now, with only a couple of exceptions, completely converted. Great job :) Reorganisations * Arch Guide ** https://blueprints.launchpad.net/openstack-manuals/+spec/archguide-mitaka-reorg ** Contact the Ops Guide Speciality team: https://wiki.openstack.org/wiki/Documentation/OpsGuide * User Guides ** https://blueprints.launchpad.net/openstack-manuals/+spec/user-guides-reorganised ** Contact the User Guide Speciality team: https://wiki.openstack.org/wiki/User_Guides DocImpact * After some discussion on the dev list, we're adjusting our approach to this problem. Watch this space. == Speciality Teams == No updates this week, as I'm totally disorganised. Next week for sure! == Core Team Changes == I would like to offer a warm welcome to Atsushi Sakai as our newest core team member. Welcome to the team :) We will resume regular reviews in February 2016. == Doc team meeting == There's been some confusion over the meeting schedule, but as far as I can tell, these are the next meeting dates: Next meetings: US: Wednesday 20 January, 14:00 UTC APAC: Wednesday 27 January, 00:30 UTC Please go ahead and add any agenda items to the meeting page here: https://wiki.openstack.org/wiki/Meetings/DocTeamMeeting#Agenda_for_next_meeting - -- Keep on doc'ing! Lana - -- 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/ iQEcBAEBCAAGBQJWmHLwAAoJELppzVb4+KUydocH/30zQwOcQ7kOPSeWIYvGPJ6u /WO2Tv9QkoOZe4O7WulkTRXTsVTlr9lP3esANYf9Vys8E1720Wl3pPNL6YYJ8XCe 1WWIxZpZNiIRB86dfgJn6/oLdhNjAS6W6SvNHNKtecQ5m/6Kv0uRfpVHxw89BRBV +f5QvPnDsydUlKEamQJAyRWzKc6BnpM/AbgS20BL3/luhZpZI3V1Z2bnxbGJCRlD 10uAwY3+z6Oo3SCQI7HVe3TfZQDa6BBYPUK2KSlY5Kr8VjclEgy4tuootRd/4rva WCS4Z61XPvR6DQdLPS6RVCmCrkRtHd1yYeBZt5fP9GBDrXm2CUZipl13grZMXY8= =XuVl -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] [doc] DocImpact vs. reno
-BEGIN PGP SIGNED MESSAGE- Hash: SHA256 On 11/01/16 23:42, Sean Dague wrote: > > This conversation has gone on long enough I've completely lost the > problem we're trying to solve and the constraints around it. Thank you :) > > I'd like to reset the conversation a little. > > Goal: to not flood Docs team with vague bugs that are hard to decypher > > Current Approach: machine enforce extra words after DocImpact (not > reviewed by doc team) > > Downsides with current approach: > * it's a machine, not people, so clarity isn't guarunteed. > * the reviewers of the commit message aren't the people that will have > to deal with it, leading to bad quality control on the reviews. > * extra jobs which cause load and inhibit our ability to stop reseting > jenkins votes on commit message changes > > My Alternative Approach: > > File doc bugs against project team instead of doc team. Make passing bug > to Doc team a project team responsibility to ensure context is provided > when it's needed. I'm happy to try this, as long as the PTL's of the defcore projects agree. > > This also means there is a feedback loop between the reviewers and the > folks having to deal with the artifacts (on first pass). - From docs perspective, it removes the triaging burden off us. If teams are happy to take that on, I certainly won't stand in their way. Lana - -- 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/ iQEcBAEBCAAGBQJWlDWBAAoJELppzVb4+KUyhg4H/j2KKMKQDht9qjbIi80L9CgH dzC59in/iUqRSjkAt44YG9ikwTQ5zPjIerR7Gj6Lmvm4cijWMoU+rhgO+7A07Nb4 sSADhjcshT8KPhJM/c9jf7BbZld7mGRZ7FrwH+FaxL8ESlcCbaEU9qVSxuwVciJy ZALGroVDnILQmT5jzOLhOTNzuSW2FZlwamDhuV5TUp3LI8sLlnR0+W5K/6gC4Lmr LEtIlvsEUk/7bNC3915jMiIrQuGwUBdxL0Z6xcPHRhkXHeiJUHvB31+4kxK8FqVc GTQWJKNi9yAJ/GQ360vbXhY6HNnVTz0Fs22jlneAu48tlJqqtO6g0KHN8NZVHBc= =T8bN -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] [doc] DocImpact vs. reno
-BEGIN PGP SIGNED MESSAGE- Hash: SHA256 On 09/01/16 14:07, Tom Fifield wrote: > On 08/01/16 21:15, Sean Dague wrote: >> On 01/07/2016 06:21 PM, Lana Brindley wrote: >>> >>>> On 7 Jan 2016, at 2:09 AM, Sean Dague <s...@dague.net> wrote: >>>> >>>> On 01/06/2016 09:02 AM, Jeremy Stanley wrote: >>>>> On 2016-01-06 07:52:48 -0500 (-0500), Sean Dague wrote: >>>>> [...] >>>>>> I think auto openning against a project, and shuffling it to >>>>>> manuals manually (with details added by humans) would be fine. >>>>>> >>>>>> It's not clear to me why a new job was required for that. >>>>> >>>>> The new check job was simply a requirement of the Docs team, since >>>>> they were having trouble triaging auto-generated bugs they were >>>>> receiving and wanted to enforce the inclusion of some expository >>>>> metadata. >>>> >>>> Sure, but if that triage is put back on the Nova team, that seems fine. >>> >>> So you’re thinking we should make all docimpact bugs go to the project bug >>> queue? Even for defcore? >> >> Yes, because then it would be the responsibility of the project team to >> ensure there is enough info before passing it onto the docs team. I'm willing to try this, if the defcore teams approve. >>> >>>> >>>> It also doesn't make sense to me there would be a DocImpact change that >>>> wouldn't also have a reno section. The reason someone thinks that a >>>> change needs reflection in the manual is that it adds/removes/changes a >>>> feature that would also show up in release notes. Perhaps my imagination >>>> isn't sufficient to come up with a scenario where DocImpact is valid, >>>> but we wouldn't have content in one of those sections. >>> >>> I can think of plenty. What about where a command is changed slightly? Or >>> an output is formatted differently? Or where flags have been removed, or >>> default values changed, or …. >> >> Nearly all of those changes have been triggering release notes at this >> point. They are all changes the user needs to adapt to because they >> potentially impact compatibility. Wow. That'll make the release notes process painful this round ... o.O > > Would love it to be the case, but I don't think that's correct. Or if it's > supposed to be correct, it hasn't been well communicated :) > > Few random reviews from the DocImpact queue that didn't have relnotes: > > https://review.openstack.org/#/c/180202/ > https://review.openstack.org/#/c/249814/ > https://review.openstack.org/#/c/250818/ > https://review.openstack.org/#/c/230983/ > > Didn't really look closely into these - would encourage someone with a bit > more time to do so, but the fact that these were so trivial to eke out means > that "nearly all" is almost certainly a bad assumption. > My experience would indicate that many, many DocImpact bugs are really not worthy of relnotes. > >>> >>> Bugs and relnotes are two very different things. L - -- 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/ iQEcBAEBCAAGBQJWkzAVAAoJELppzVb4+KUy6wEH/RFw0czHS2JBXgYTEzuk6fg1 IfLCMcCUXoIastmN+6WDaOG2OKps52p89UhJBw9eEyrRgJM6dqMGhyBCAha/7JcE /tjW5EDnZw97oaPSHhHW6TvUWOtwvt9jzx7x9escXjuDNDR1ARYdFAuuIHoS9468 6XDR+yt7AWPnQ+W4YJTf1/Kw0+V7Jiy8dGXLkxmV0K+2oFlGfSG1yGclQ+yhYOj+ E7+TXEOqHVTyzcD03XyVB8AH4vzpego7pSP+tx9KcpVjCxF5OvvqEmI4aCq+jza4 PvG3nAWIqKKbtMU1K5hdxfnwQSeqVZp/QkLhhj5EMrvJBiy/50gObeALfhc1cIE= =+E/P -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] [doc] DocImpact vs. reno
> On 7 Jan 2016, at 2:09 AM, Sean Dague <s...@dague.net> wrote: > > On 01/06/2016 09:02 AM, Jeremy Stanley wrote: >> On 2016-01-06 07:52:48 -0500 (-0500), Sean Dague wrote: >> [...] >>> I think auto openning against a project, and shuffling it to >>> manuals manually (with details added by humans) would be fine. >>> >>> It's not clear to me why a new job was required for that. >> >> The new check job was simply a requirement of the Docs team, since >> they were having trouble triaging auto-generated bugs they were >> receiving and wanted to enforce the inclusion of some expository >> metadata. > > Sure, but if that triage is put back on the Nova team, that seems fine. So you’re thinking we should make all docimpact bugs go to the project bug queue? Even for defcore? > > It also doesn't make sense to me there would be a DocImpact change that > wouldn't also have a reno section. The reason someone thinks that a > change needs reflection in the manual is that it adds/removes/changes a > feature that would also show up in release notes. Perhaps my imagination > isn't sufficient to come up with a scenario where DocImpact is valid, > but we wouldn't have content in one of those sections. I can think of plenty. What about where a command is changed slightly? Or an output is formatted differently? Or where flags have been removed, or default values changed, or …. Bugs and relnotes are two very different things. L Lana Brindley writer:speaker:blogger http://lanabrindley.com signature.asc Description: Message signed with OpenPGP using GPGMail __ 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] [openstack] Wrong descriptions for something
For most things, just log in and change it :) If you’re uncertain, you can always check here first. L > On 8 Jan 2016, at 1:17 PM, Shinobu Kinjo <shinobu...@gmail.com> wrote: > > Hello, > > If there is any wrong explanation on > https://wiki.openstack.org/wiki/**something** > <https://wiki.openstack.org/wiki/**something**>, > what is usual procedure? > > Usually I don't mind but sometimes... > > Is there maintainers? > > Rgds, > Shinobu > > -- > Email: > shin...@linux.com <mailto:shin...@linux.com> > GitHub: > shinobu-x <https://github.com/shinobu-x/> > Blog: > Life with Distributed Computational System based on OpenSource > <http://i-shinobu.hatenablog.com/> > ___ > Mailing list: http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack > Post to : openstack@lists.openstack.org > Unsubscribe : http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack Lana Brindley writer:speaker:blogger http://lanabrindley.com signature.asc Description: Message signed with OpenPGP using GPGMail ___ Mailing list: http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack Post to : openstack@lists.openstack.org Unsubscribe : http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack
Re: [openstack-dev] [doc] DocImpact vs. reno
> On 6 Jan 2016, at 1:19 PM, Jeremy Stanley <fu...@yuggoth.org> wrote: > > On 2016-01-06 11:43:34 +1100 (+1100), Lana Brindley wrote: > [...] >> I’m starting to think that DocImpact needs to simply be retired then > > Alternatively, let the remaining projects which currently auto-open > bugs for openstack-manuals switch to opening bugs against themselves > and allow their bug triagers to redirect them to the docs team once > the requisite details are determined. And then if those projects > don't want to do the work of enforcing or researching the reasons > for docimpact headers in individual changes, they can decide to stop > supporting them on a project-by-project basis. Well, we’ve already done that for big tent projects. The new job was the solution for the ‘defcore’ projects, which we were guinea-pigging in Nova before rolling it out to the others. But if Nova rejects it, I think that maybe we’re dead in the water. L Lana Brindley writer:speaker:blogger http://lanabrindley.com signature.asc Description: Message signed with OpenPGP using GPGMail __ 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] [doc] DocImpact vs. reno
> On 6 Jan 2016, at 12:35 AM, Sean Dague <s...@dague.net> wrote: > > On 01/04/2016 08:01 PM, Lana Brindley wrote: >> I’m late to this party because holidays (Thanks Anne for bringing it to >> my attention). >> >> First of all, sorry this came as a surprise. I tried hard to make sure >> everyone who needed to know knew, but that’s naturally a difficult thing >> to do. >> >> To the implementation details: I really am struggling to see how Reno >> could be used as a DocImpact replacement, unless you’re going to use it >> to somehow enforce that packages with DocImpact include some kind of >> text file in the commit. That would be complete overkill, and has the >> potential to really mess up the development repos (who needs random text >> files littered around?). Maybe I’m missing something here, though. >> >> Really, the intent of the job is merely to check for a description after >> the DocImpact tag that gives the docs people a hint as to what you were >> thinking when you added the tag. It’s simply a time saving measure on >> our part, and sometimes a thing that saves a large amount of human time >> needs to take a small amount of compute time. I don’t think that’s a big >> ask, but again, please correct me if I’m wrong. >> >> In short, I would rather remove the DocImpact facility entirely than try >> and turn a tool designed for a completely different task to this >> problem. However, as this is the first complaint I’ve seen about this >> solution since starting working on this thorny problem nearly a year >> ago, I can’t help but wonder if we’re overreacting? Do people genuinely >> hate this solution enough that we need to go back to the drawing board? > > Yes. Because as I described it scuttles a whole other long term goal > (which is being able to update commit messages and keep Jenkins votes). > Voting based on commit messages is a thing we need to not be doing. > > You can score based on content in tree, just not commit messages. OK, I wasn’t aware of that requirement. In that case, I’m starting to think that DocImpact needs to simply be retired then … L Lana Brindley writer:speaker:blogger http://lanabrindley.com signature.asc Description: Message signed with OpenPGP using GPGMail __ 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] [doc] DocImpact vs. reno
ges. >> >> When the docimpact spec was written, reno was not in use - and later >> nobody brought it up as alternative idea. >> >> The idea going forward is instead of checking the commit message, is to >> add a special section using reno that explains the changes that are >> needed. A post-job would run and create bugs or sends out emails like >> today whenever a new entry gets added. But this would be triggered by >> special sections in the release-notes and not in the commit message. We >> also expect/hope that release notes get a good review and thus the >> quality of these notifications would be improved. > > So you want to add a special section to the reno note file, similar to > "upgrade" and "fixes" but to replace documentation impact notes? What > would use the contents? > > Doug > >> >> Let's look on how exactly we can do this next year, >> >> Andreas > > __ > OpenStack Development Mailing List (not for usage questions) > Unsubscribe: openstack-dev-requ...@lists.openstack.org > <mailto:openstack-dev-requ...@lists.openstack.org>?subject:unsubscribe > http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-dev > <http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-dev> Lana Brindley writer:speaker:blogger http://lanabrindley.com signature.asc Description: Message signed with OpenPGP using GPGMail __ 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] [COA] How to get involved
I’m curious also, about who wrote the content and is maintaining it. L > On 10 Dec 2015, at 4:04 AM, Remo Mattei <r...@italy1.com > <mailto:r...@italy1.com>> wrote: > > I am in contact with someone but I have not done much yet since it just > started. > > Remo > > Inviato da iPhone > > Il giorno 09 dic 2015, alle ore 18:21, Adam Lawson <alaw...@aqorn.com > <mailto:alaw...@aqorn.com>> ha scritto: > >> I know Foundation is working on the exams and certification process for >> OpenStack Administrators. >> >> For someone who desires to participate/assist in this effort, who is leading >> the charge? I can't seem to find reference to it anywhere although I noticed >> a number of fellow sponsors were listed in the press release as having >> participated thus far. I didn't know the opportunity even existed so I am >> wondering is the COA effort invite-only or did I just miss the email? >> >> //adam >> >> Adam Lawson >> >> AQORN, Inc. >> 427 North Tatnall Street >> Ste. 58461 >> Wilmington, Delaware 19801-2230 >> Toll-free: (844) 4-AQORN-NOW ext. 101 >> International: +1 302-387-4660 >> Direct: +1 916-246-2072 >> >> !DSPAM:1,56686711252282015510716! >> ___ >> Mailing list: http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack >> <http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack> >> Post to : openstack@lists.openstack.org >> <mailto:openstack@lists.openstack.org> >> Unsubscribe : http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack >> <http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack> >> >> >> !DSPAM:1,56686711252282015510716! > ___ > Mailing list: http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack > <http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack> > Post to : openstack@lists.openstack.org > <mailto:openstack@lists.openstack.org> > Unsubscribe : http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack > <http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack> Lana Brindley Technical Writer Rackspace Cloud Builders Australia signature.asc Description: Message signed with OpenPGP using GPGMail ___ Mailing list: http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack Post to : openstack@lists.openstack.org Unsubscribe : http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack
