canonical / open-documentation-academy

Learn open-source software documentation skills with Canonical
https://canonical.com/documentation/open-documentation-academy
Apache License 2.0
72 stars 43 forks source link

Developer Guide: How-to install Ubuntu Desktop for developers #135

Open rkratky opened 3 months ago

rkratky commented 3 months ago

Context

Ubuntu Desktop for developers is a new documentation set that is geared towards application developers who wish to use Ubuntu Desktop as their development platform. It is not meant for developers who participate in the development of the Ubuntu distribution itself (nothing is stopping them from using the guidance the docs provide, but their use case is not what informs the strategy for the content of this docs set).

The Dev Guide focuses on work with six toolchains:

The basic structure of the docs set consists of two main parts:

Task

Develop docs to populate the generic-guidance part of the docs set, i.e., the non-toolchain-specific parts of the Developer Guide. There are three parts to this:

This task is about the first part: How-to install Ubuntu Desktop for developers.

A straightforward how-to guide (see Diataxis how-to and/or talk to @rkratky) on installing Ubuntu Desktop to serve as a developer workstation. This SHOULD NOT duplicate any existing (up-to-date) documentation on general installation. Links (or points in prerequisites) should be provided to this generic installation content.

The gist of this article should be:

This article SHOULD NOT go into details about specific software, nor should it delve into instructions about indiv. toolchains. If any of these need mentioning (e.g. during 'extended install' selection), a link should be provided to the respective how-to that covers that topic in detail.

Reference

Note: This docs set is not yet published because it's still largely incomplete. If you decide to work on this issue, I will provide you with access details to be able to see the non-public version.

davidekete commented 2 months ago

Hi @rkratky, I'd like to work on this.

rkratky commented 2 months ago

Fantastic. I'll assign the issue to you. I see you also commented on the other two related issues. Would you like to work on all three simultaneously?

davidekete commented 2 months ago

Fantastic. I'll assign the issue to you. I see you also commented on the other two related issues. Would you like to work on all three simultaneously?

Yes, I would like to work on the simultaneously, since it's a doc set, I though that would be best.

rkratky commented 2 months ago

Yes, I would like to work on the simultaneously, since it's a doc set, I though that would be best.

Cool. I'm assigning them all to you then. Let me know if there's anything I can help with.

davidekete commented 2 months ago

Yes, I would like to work on the simultaneously, since it's a doc set, I though that would be best.

Cool. I'm assigning them all to you then. Let me know if there's anything I can help with.

No problem. Thank you.