canonical / open-documentation-academy

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

Multipass: improve category landing pages #64

Closed nielsenjared closed 3 weeks ago

nielsenjared commented 2 months ago

Hey @rkratky ! Here's a first pass at the how-to landing page. Let me know if I'm on track and I'll proceed with the other three.

You'll notice I left a few TODOs in place of the lists of links. How are links rendered? Do I need to add them? If so, is the syntax standard Markdown. Or does the template engine insert them? If so, is there a variable I need to insert?

rkratky commented 2 months ago

@nielsenjared, this is really good, thanks! Feel free to suggest content for the other landing pages in this manner.

(The lists of links are generated automatically, so no need to use placeholders for them.)

townsend2010 commented 2 months ago

Hi @nielsenjared!

This is really great! I'm currently working on improving the landing pages, this is exactly what I need. :smiley: I can apply your changes here to the Discourse docs if you are ready.

Also, as @rkratky pointed out, please feel free to contribute to the other landing pages as well.

nielsenjared commented 1 month ago

Hey @rkratky & @townsend2010 ! I just pushed text for the Explanation and Reference landing pages. I removed the links from the How to Guide. I noticed that the text on the Tutorial page was udpated recently, so I removed tutorial.md. Changes are ready for Discourse!

townsend2010 commented 1 month ago

Hi @nielsenjared! I've applied these changes to our Discourse docs. Thank you so much for your contribution!

townsend2010 commented 1 month ago

Hi @rkratky,

I've applied the changes here to Discourse. I'm not sure how this is supposed to be closed. Thanks!

rkratky commented 1 month ago

Thanks @townsend2010. I'll handle it next week.

giuliazanchi commented 3 weeks ago

Closing as the changes were merged into Discourse and this PR is no longer applicable.