search

canonical / open-documentation-academy

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

Launchpad: group articles of the Explanation section into proper subsections #115

Open jugmac00 opened 6 days ago

jugmac00 commented 6 days ago

Documentation: https://documentation.ubuntu.com/launchpad/en/latest/explanation/ GitHub repo: https://github.com/canonical/launchpad-manual Contribution guide: https://documentation.ubuntu.com/launchpad/en/latest/contribute-to-our-docs/

The explanation section contains a vast list of links to articles giving valuable background information to developers who want to contribute to Launchpad.

The length of the list makes the page ( https://documentation.ubuntu.com/launchpad/en/latest/explanation/ ) very inaccessible.

Ideally, we want to group the items into coherent subtopics, and also offer a quick introduction to these subtopics, similar what has been done for https://documentation.ubuntu.com/launchpad/en/latest/how-to/

This issue involves two parts:

The second part of the issue has been done before by @nbarbarick in https://github.com/canonical/launchpad-manual/pull/56 - have a look at that PR to get an idea what needs to be done.

nbarbarick commented 5 days ago

Hello, can I be assigned this issue?

I could likely suggest subtopics and consult on introductory text before the end of next week.

jugmac00 commented 5 days ago

That is fantastic news! @nbarbarick, thanks for picking this up!

@degville would you kindly assign @nbarbarick? Thank you!

nbarbarick commented 5 days ago

So, @jugmac00, would you prefer that I post questions or suggestions on the grouping of subtopics in this thread or in some other forum?

jugmac00 commented 4 days ago

Thanks for asking. Indeed I think it makes sense to have that discussion on the Launchpad bug tracker at https://github.com/canonical/launchpad-manual/issues/80 - so the technical authors who maintain this generic bug tracker do not get flooded with notifications.

Also, all Launchpad engineers are subscribed to the above mentioned board, so you should get better turnaround when I am not available.