 Okay, cool. Okay. Let's get started show you. So this is the project update for the documentation team We look after the open stack manuals our post tree. So my name is Alexander settle or a settle on ISE I am the PTO for the pike release and these are my colleagues. If you'd like to introduce yourselves Yes, I'm all gone. I'm a call reviewer in their role One-stack the commutation upstream. So I'm with their community with open stack for three years already It's great time. Thank you So we are here just to present the update of what we plan for the pike and for We have the third so the picker it's my teammate, okay Thank you, Olga. I'm Alex. I'm happy to see you here I will talk a few words about writing security documentation Impact and the importance of this activity for the project for the upcoming release project So this is the three of us. There's a team of probably about I think it's probably about ten or twelve cause We are quite a big core group, but we're not all full-time I work like of all full-time working upstream. I should say So I've been working on the project for about three and a half years now. So since the ice house release So just been a little while now. Anyway, so As if you've been to these project updates before you will know that we're gonna go through a little bit of what's happening in pike Which is the current release? What we're planning to do for the following releases, which is going to be Queens and Rocky And then we're just gonna have a little bit of questions and feedback So we're gonna kind of keep this is like not the most in like formal thing ever I know that it's recorded, but you know, it's just kind of make it chill. Let you know what's going on and move from that So what does our documentation team do so essentially like we are officially the open-stack manuals team And we currently look after the open-stack manuals. These are all of our repositories So we do the API ref security doc training guides and training labs The API ref security trade and the training sections are actually all under different specialty leads So if you sort of look at it like an umbrella, there's me at the top We have our specialty leads and all of our cores which look after the Ups-deck manuals So we actually have quite an extensive amount of documentation to look after we have user guides admin guides Networking installations Deployments, it's quite a vast selection of stuff We will continue So what do we do? We pretty much focus on the creation maintenance and organization around docs.opens-deck.org So if you've ever been to that site before it is Quite large, but we this is where we keep all of our main documentation and it's actually one of their most searched sites for open-stack So it's open step wwb.opens-deck.org first and then it's docs.opens-deck.org So we have a really large customer base, which is really important for our users and operators Okay, so we were unofficially founded in the Austin release And then we were officially from Bexar. So 2010 ish It was actually started by Ann Gentel who is still a major contributor and she actually looks after our API references We had 162 contributors for the latest release As you can see here, the 61% of the community members use documentation daily or weekly. This is really big It means we have a lot of people coming and looking at what we're doing Which means we're in the spotlight all the time. There is a lot of pressure to update things continuously But we have a solid team looking after that and we have a lot of the community is really supportive We have Liaisons so we have doc liaisons. So like the Glance team have a liaison for documentation for us And we try and make a community the community all banned together to make it happen so Mike, Olga Okay, so it's quite obvious that the major focus of All the documentation is user experience course docs is user experience Also, we Some work on my manageability as well Now I'm going to move on With there are a new features and enhancements that we plan For the pike. So the first one is Achieving all the documentation on Docs or OpenStack orc this So this addresses the requirement to achieve all the docs that That is not I'd make it Available to the users who are who need it course. We know that Lot of people just come to us and say that today need the other eyes also at least and but Yes, it's the problem So what is the plan we have we have the Specification of red the ready already the plan is to That at every new release there at least that it comes and of life We just make the The folder that is read or read only that that can be downloaded by the user Built a law locally as well as make it available From the from the docks or post at org another Enhancements is moving the administrator guide to project reapers as you may know that the number of projects of OpenStack projects is getting Begin and bigger with this release but the docs team is shrinking just so we need to keep keep them up up to date and to Deal with the problem we decided to move them to the project Poder repositories just the same way we did it with the installation guide and References the sub as the sub tasks for this enhancement for this improvement is also set and up a cookie cutter For all we know from the in the install guide and deployment guide tool for developers as well As so check in cleaning up and that is in the content of the guide to to align the There are content with their conventions that we have in their Contributor guide for documentation Um, I'm on then other new features is their continuum revision of their Architecture design guide just to make the other content Just to to create the obstruction between the cloud Architecture core concepts and various OpenStack pro objects So and the last Probably not the least in this release and enhancements is adding The support for for Reno That was one of their major tasks From Atlanta PDG Thanks to Adam Spears Him him made it of it Very available him he made it happen and now our repository Support Reno so I Also to I want we decided that it's better once once to see Then here for several times and I want to present just as a small demo to To show how it works. So there are you you use cases very simple It's it in the result. We we will recreate their It is no note reports report under the under the subsection of the Release notes. So let's let's start our first you need to install the rena tool Just to have it and On on your machine, and then you install the sphinx in x extension that is built in it And and rena you would see it to build Their notes Once you've done it You need to Took took long their repository. It's all Let's take my nose in our case. So you change the directory to the repository and Here I will need to their it is not that directory. So So I know you you just keep the brother workflow you with this View you eat the branch for you for your change And then are you using their rena new comment you create a new? Listeners reports report. It will create a yaml file And that will be stored under the list now knows that directory actually That's successful So you check here read the file that we created You can see it So now we are need to add their content our tool this file so you open the file and Edit the template that is already there with all of the sections. I decided just to add some text some tool tech on tributary guide sec section so We edit it with we save the file and Now it's very important before you built To see the output for your use to talks you need to add to Commit your your change course talks will will Use the locks to build the other output So you you can unmute your your change Create the Garrett Yeah, so It there are you Now I will recommend that you check there the output you was in talks comment You can view it locally In the build to build directory that is Recreated automatically once you run talks so open Unreleased and in there Exciting things about what we've done with Reno is usually you'd come with a set of a Format a template that was just simply like updates config We worked with the Reno team and specifically Doug Hellman and Adam Spears to actually make this Completely separate for docs. We made sure that we're actually able to update per book rather than per project So that was just I'm sorry. I just wanted to quickly add that Change I checked that the time it ends in place marked it now Okay, I'm I'm market as a broken progress not to to confuse the reviewers and in a while you just can check The build So it's in place. It looks good Under there as I remember we created the one under the Release subsection. So it's here Okay, back to the template. Yes, it's good and I Think that we have all the ear ears in place here from the Changers that are we are visible to you through the users so that that can be you some changes in you are and on The site as well as some some in in internal chair and just like translations or something like that and also the template includes the section that that are indicated to The guy through the guides something like user admin and and and so on so forth So and if you want to add some some section, you just need to To commit the change not to the project itself here But but for for this template to go to code on figure. Yeah, I'm a file. So that's the workflow. Thank you So That's that one previously We were actually building all of our release notes manually which meant at the end of each release It was up to the a specialty team leads to build it one of the problems that we've been having is We've been losing like major core contributors to the documentation project Which has led to less people being able to form these specialty teams Which then has also meant that we're losing, you know, we're losing the ability to like have concentrated efforts So we're trying to re-centralize and having the Reno support release notes was really important for that I'm having something automated that our contributors could directly can contribute to So I just also wanted to talk about this one last thing that we've actually worked on at a very last minute This is a governance documentation tag. So governance has tags to govern projects We actually previously haven't had anything like this for documentation It's this is just designed that Okay, let me start this again because I'm rambling in circles Basically, what happened was is it got to a point where our installation guides? We're not being verified by anyone outside of the documentation team, which in fairness is our domain But it is becoming less and less our domain because we've been pushing the installation guides back on the project team And we're about to do the exact same thing for the admin guides this is important because a Doc information per information developer or a technical writer has a base level of information on every project They do not have the in-depth knowledge that a developer and a key operator and user has on that totally different side So we can easily go through and verify these guides by just going click step by step But a full manual install takes several days And what was happening is we were finding a lot of failures later on because we were there was a communication There was like a distance in communication between what was happening in the projects versus what was actually being documented upstream And because essentially we are the official documentation that was a big problem when no one can install and no one can start up an instance so I Through a little tantrum and I went up to the government's depart Governments repo and I was like we need to make this official We need to have a check that these projects are actually making sure that they are verifying this and what this means is that They get this tag associated with their project once they have verified their guides So this all applies to not only the installation guides But the admin guides that we're also going to push out as Olga was mentioning So this is going to be really important for like the future This is specifically for our users and also like our operators and developers as well Just so that they know that this is going to be important to our future But this was a bit of a random last-minute thing after we've kind of had a couple of releases now Where things haven't quite gone as smoothly as they probably should have So we're trying to govern it a bit more and make it a bit more Easier basically so Alex is going to go through Queens now Unexpectedly Queens has Continuation of the activities started in pike But what's what's different is you can see the major focus is on security during this release as you know open-stack documentation has Security guide created With the help of Rob Clark's security team Unfortunately, it's been created like for for many years ago and need to be redesigned reconstructed taking situation new features and new threads we have and That's why We have linked to either part where we collected the main problems Found in my security guide and the new table of contents so you can actually take the participation In this in this activity as well Um, luckily, I was involved in writing security best practices for merantis and this sounds pretty pretty much similar and I can emphasize that actually bad things happen by day two. So when it's everything is deployed it works well, but Some vulnerability it can be found and Administrator need to think how to how to fix this one with how to patch apply the patch and Here our security guide comes Yeah, thanks it's obviously to release time from now and This is a little bit harder to think this far forward because one of our biggest things is user experience Documentation is all about the user who's reading it. Who's our customer and our customer is always the operator In saying this, you know, our biggest problem right now is what is our future? So we've been you know today has been really big for us at 12 o'clock We had a session on you know, what's the future of the documentation team? How are we going to keep continuing maintaining our docs the way we currently are? Historically speaking, we've always had a team that has been able to dedicate time to this process and we've also had plenty of one-off contributors or Irregular contributors from different projects that are able to put in the time and effort to help us But this is becoming less and less Available so we've had a lot of discussions about where we're going to go We're trying to automate as many documents as we can so we're already looking at automating our configuration reference and our command line documents We're looking at creating new scripts. We're also looking at pushing the administration guides and all of the Install guide back to the project repose and with that we are then going to switch the process of most likely This will be a specification. So I'm definitely giving you insider info as of from 12 We're going to look at instead of there being a liaison from the development team to us We're going to be liaison specifically to the team so as an example, I would look after the Nova team, but I could also then do three what are called optional projects so that way I could maybe look after designate Swift and The banana project That doesn't exist So, you know what? I mean like we're trying to kind of come up with new ways of doing this thinking new even things But this is our key focus for Rocky I'm not going to stand here and tell you that we're going to have all these amazing things happening because right now Our main focus is what's going to happen? We have an amazing documentation suite and it can all be maintained by the like the Community, but we need to be looking a little further ahead now We did start everything in Austin and technically Bexar, which has been a really long time But that doesn't mean It's going to keep going full steam ahead the way it is We have to start thinking about the future and how this is actually gonna like in how we're gonna actually make this work Because I mean the amount of times Had a lot of people say, you know documentation is so important documentation is so important But you that doesn't really come through at the end of the day, you know People are really happy to say what they want to say to your face When it comes down to it, you know, we really struggle to get contributors and realize that documentation is important I could stand up here all day and tell you about how the users need documentation and without the users You do not have a development project. I mean you do but no use it But you know that aside, this is our focus So yeah, that's kind of where we're going and we'd love to have people along for the ride and working on it with us We've got some cool things coming up. We're archiving. We're moving back But we're still also keeping our core team together and making sure that we're a centralized team So that's really important to us right now But yeah, this is a slide that they kind of made us do I'm sure you guys have kind of seen it by now, but it's pretty much just like a couple of questions I mean if anyone Can help us anyone who operates and uses open stack and has used our guides before love to hear from you But if you haven't that's okay as well, or if you just have other questions that works as well But this is kind of where we're at right now. What we're thinking and this is just Like random questions. This isn't you know any targeted anything. We're just trying to figure things out where we should be going You got any questions or you got any bright ideas? I'm right here Thank you. I Wonder if opensack.org has some analytics that will help to figure out like how our users They reach the documentation whether they enter the main page main documentation page doc doc's open stack.org. Yeah The other is like special separate like flow users for flow that will help to figure out how how how users get the documentation What what what they're looking for actually? Spend a lot of time looking down to is that our install guide is absolute top So when if these analytics basically show that the as far as open-stack concern the top hit goes to open-stack.org And the second top hit is docs at open-stack.org and that is by a million views It's it's really intense, but that's also great. It means that you know people are viewing it and they want it And they're interested And then from there we've noticed that it's our install guides and our networking guides They are absolute top, but networking is it's very specialized We don't have a lot of people that are able to do this intense networking configurations Because it's not just down to the neutron team. It is so much more than that and it's really quite difficult So I mean we have all these numbers and we're able to point You know the Chinese contingent is huge our translation team Works, you know over time to get the Chinese translations out. Whoopsie daisies. Sorry guys We've most recently moved to using PDFs as well Simply because the Chinese contingent definitely wanted this this was important for them They wanted to be able to download it and hold on to that document rather than having to access the internet constantly So yeah, I mean This that's a that's a good and they'll point us in the right direction sort of But it can be a bit. I don't know if yeah, I mean, it's funny. We can look out here I've got them all downloaded. I've got a lot to go through But yeah Yeah, can I click on some go for it, please if it's not secret? No, I think that is real time. Okay Yeah, any thoughts any questions or are you guys all just here because it's an empty room if you are that's okay Thanks, Amy Yeah, anyway, I don't have anything else. I don't think unless anyone has any questions about Project stuff, but if anyone's interested we have an operations and administrations guide moderated session tomorrow we're going to be looking at the overlap between these guides because well administration is for operators and the operations guys also for operators But one is slightly more theoretical and one is definitely more practical But it is definitely maintaining two things at once that probably don't need to be so we're kind of trying to hopefully reach out To our operators and see what they actually want rather than guessing So if anyone's able and interested to attend that that would be great We also have a session on developer.opensduct.org Which is our API site which we look after all the API and SDKs as well So if anyone wants to come talk about that as well, we'll be doing that on Wednesday We'll be looking at you know, who's our audience? What do what do they actually want because at the moment nobody seems to know Which seems to be a common problem with OpenStack Yeah, cool Excellent love the blank faces Thank you