The big news this time around is that we’ve switched to using a new URL: documentation.ubuntu.com/project. Ain’t it pretty? Anyway, we’ve also added a lot of new content, fixed a sizeable chunk of existing content, and set the stage for whole new areas of docs (hint: Community team’s docs).
Are you wondering what all this is about? Check out our entire article series:
Ubuntu Project docs
- Bringing together 20 years of documentation
- Ubuntu Project docs: MIR, ACLs, and more
- Ubuntu Project docs update: making sense of the contributor story
- Ubuntu Project docs: welcoming our first contributions!
- Ubuntu Project docs: Will it blend?
- Ubuntu Project docs: Sorting things out
- Ubuntu Project docs: Piloting ‘article series’
- Ubuntu Project docs: Another day at the office…
- Ubuntu Project docs: post pit-stop push
New address for the docs set
While the docs remain a work in progress, we felt it was high time we switched from using the rather ugly default ReadTheDocs address to a shiny new URL anchored in the docs.ubuntu.com space. The more we send people to the new docs and ask them to kick the tires of the content, the more useful this friendlier address is.
You may recall from Sally’s last update (Ubuntu Project docs: post pit-stop push) that she had started to “redirect” the individual pages of the Ubuntu Maintainers Handbook (UMH) to the new docs. We’ve also been adding either redirects or links to the wiki as we go along (this now includes the Bug Squad and bug triage pages – not all the BugSquad pages have been moved - some, like the knowledgebase, are still on the wiki).
All old pointers to the original address (and therefore bookmarks, links, etc.) should automatically redirect to the new address. Please, let us know if you come across a 404 or some other hiccup with the new setup.
Progress on Release team docs
Sally has continued working with the Release team on getting their docs out of the staging area and slotting them into the right places within the Project docs (with redirects from the wiki pages). All of their public documentation has been updated and moved, except the seed management pages (which require a more detailed review and fixup, which the Release team are going to do).
Developer Membership Board (DMB) docs
Sally has also continued on cleaning up and de-duplicating all the content in this space. As usual, @paelzer has been a lot of help with various suggestions and clarifications.
This work also included improvements to the “path to upload rights” diagrams ahead of moving the rest of the DMB content in the next week.
Polishing the Contributors section
I busied myself with many updates and fixes in the Contributors section of the docs set. This included de-duping articles on Committing changes and Building packages. I meshed content from the wiki and the UMH, reformatted the whole thing, and added instructions that were missing. @waveform has been a lot of help in this area.
In another rather large change, I subjected the Sponsorship docs to the ‘article series’ treatment. This involved consolidating the various scattered pieces of info, more de-duping, fishing content from the wiki, as well as developing completely new guidance for sponsors (thanks to @enr0n and @bdrung for their input and advice on this).
This has now tied together articles for both contributors (how to find sponsors and request sponsorship for syncs and uploads) and maintainers (how to review MPs and sponsor syncs and uploads). I like how the story is emerging from the chaos
Meta
Small update in the form of a new section in the guide for contributing docs: I added a description of the {matrix}
link role, which allows us to create links to ubuntu.com-hosted Matrix discussion channels easily. I already mentioned this feature in a previous update (Ubuntu Project docs: Piloting ‘article series’: Housekeeping) but forgot to actually document it. Fixed that oversight now.
What’s next
Sally will be migrating the git-ubuntu
docs and the Community team’s docs (the first PR is already waiting in the queue), while I’ll try and get the SRU and Governance docs in. Time allowing, we’ll be continuing the de-duping and clean up quest.
How to contribute/get involved
We continue getting contributions, which we’re really happy about (thanks, @vhaudiquet!). Now, more than ever, we could use eyes on the content. So much more has been added, the UMH has been gutted (in a good way ), and we need people to start really using this new docs set.
Tell us what’s good, what isn’t, what’s missing, etc. You get the idea.