Ubuntu docs: together in electric dreams

It’s my turn again to say “hi!” and to welcome you to another update from documentation-land!

There’s been a lot happening in the last two weeks, as we try to leave things in a good state before the end of the year. I’ve also been having a lot of fun playing with The Robots and trying to understand how we can (and can’t) use them to help maintain documentation in a thoughtful and sensible way. More on that below!

Other articles from this cycle:

  1. Ubuntu docs: here we go again

What’s happened in the last two weeks?

HW support docs

As part of the effort to consolidate Ubuntu docs that have so far been scattered all over the place, @rkratky is setting up a rather specialized documentation set: guidance about support for various hardware platforms that require some special consideration. At first, this will include existing docs about running Ubuntu on various ARM (including Raspberry Pi) and RISC-V boards. Other content will follow.

The basic skeleton repo has been set up already. There’s nothing in there yet, but Robert will be bringing over the mentioned ARM and RISC-V docs in the coming days, and then we’ll publish the site and configure redirects from old locations – the usual :slightly_smiling_face:

ubuntu-policy consensus

In our last update, Robert talked about the neglected ubuntu-policy package that is home to the Ubuntu Policy Manual. Since then, it’s been agreed that the best course of action is to publish the Ubuntu-specific parts of the Policy in the Ubuntu Project docs (with requisite ownership setup to ensure the Ubuntu Technical Board retains control over the content) and subsequently retiring the package.

This is now tracked as part of the Project docs technical debt in issue #333: Publish Ubuntu Policy. If this sounds like something you’re interested in tackling, please feel welcome to get involved!

Wiki announcement

@shanecrowley recently announced the project to create a new Ubuntu community wiki, with the decommissioning of the two public Ubuntu wikis in view. This project represents another important consolidation effort, since it allows us to refresh the underlying infrastructure onto something more modern and secure, and with a visual overhaul to match. Shane’s Discourse post gives a great overview of the current landscape, and you can look forward to more updates from him about the new wiki over the course of the cycle!

Pro for WSL launch

The Pro for WSL app was successfully launched last week :tada: it’s now available to download from the Ubuntu website and the Microsoft Store. If you want to try Pro for WSL for yourself, follow the team’s tutorial – alternatively, Shane has worked closely with the team to create an excellent Youtube video to accompany the launch. Check it out on Youtube!

Adventures in AI

As Robert reported last time, I was planning to upgrade the tooling for the Ubuntu Server docs, and this is now done! However, while doing so I spotted an opportunity to exercise some of the popular LLM agents with a series of tests against the docs. What can I say? I’m a scientist at heart and I love doing experiments (but I also like to be fashionably late to a party :upside_down_face:).

I’ll write up my findings in a detailed blog post in the new year, but I’ve been creating pull requests out of all the tests if you want a sneaky peek. I went into this as a bit of a skeptic, but I’ve been pleasantly surprised by some of the workflow improvements. One such example is the set of tiny config tweaks that led to an 80% reduction in the runtime of our automated linkchecker (from 10 minutes to only 1.5 minute)! Changes like that may not be noticeable from just reading the docs, but they are real improvements that make life better for contributors.

Want to get involved?

As always, the Project docs has a well-stocked issues list that is being actively worked on by Ubuntu developers. If you’re reading the Project docs and find something that you think can be improved, leaving an issue is an excellent way to contribute. Use the “Give feedback” button at the top of any page to report problems.

We look forward to hearing from you!

8 Likes