search

canonical / open-documentation-academy

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

Public Cloud: Change table format #51

Closed k-dimple closed 5 months ago

k-dimple commented 6 months ago

GitHub repo: https://github.com/canonical/ubuntu-cloud-docs

The tables on this page consists of two columns each ('Kind', URN'). Convert them into 3 columns each with titles: 'Architecture', 'Hyper-V Generation' and 'URN'.

krzysiekwie commented 5 months ago

Happy to try this as my first issue here, I can get this done within a day from assignment

k-dimple commented 5 months ago

Hello @krzysiekwie! Thanks, please go ahead and try it. I've assigned it to you.

krzysiekwie commented 5 months ago

Hi @k-dimple I added the basic edit in https://github.com/canonical/ubuntu-cloud-docs/pull/206 (don't think I can use fixes #51 directly on ubuntu-cloud-docs).

Also I'm not sure if the first two columns should get cenetered. Github and my local rst preview does not render centering. I tried the three formats from: https://github.com/krzysiekwie/ubuntu-cloud-docs/blob/change-formatting/doc-cheat-sheet-myst.md in https://github.com/krzysiekwie/ubuntu-cloud-docs/blob/change-formatting/azure/azure-how-to/instances/find-ubuntu-images.rst

Let me know what you think.

k-dimple commented 5 months ago

Hi @krzysiekwie, adding the edit directly in the repo is perfectly fine. I have put in a comment there.

Regarding the centring, I don't think we need to centre the first two columns. It looks better left-aligned. Using ":align: center" works for the whole table. Currently, I don't think there's an option to centre only certain columns using list-tables.