search

kubernetes / website

Kubernetes website and documentation repo:
https://kubernetes.io
Creative Commons Attribution 4.0 International
4.48k stars 14.4k forks source link

Migrate to the alert shortcode from Docsy #44564

Open coder12git opened 10 months ago

coder12git commented 10 months ago

This is a Feature Request

What would you like to be added

Currently, our site only supports shortcodes for three basic alert types i.e note, caution and warning.

But, we should consider adding shortcodes for additional alert types :

Why is this needed

Adding new alert styles makes the information look better and easier to understand.

Comments

/sig docs /area web-development

sftim commented 10 months ago

We could aim to migrate to the alert shortcode from Docsy, or an extended version of that shortcode.

Aligning with Docsy reduces the long term effort for maintaining this site.

/area web-development

coder12git commented 10 months ago

We could aim to migrate to the alert shortcode from Docsy, or an extended version of that shortcode.

I agree

coder12git commented 10 months ago

@sftim based on the abve suggestion, i have changed the title

coder12git commented 10 months ago

I think if it's fine, then this issue should be given triage/accepted, so that i can start working on it

sftim commented 10 months ago

/triage accepted /priority backlog

We have other issues we'd love to see done, that are more important than this improvement. However, doing this migration would still be useful.

steve-hardman commented 10 months ago

I'm learning different aspects of website repo and learning about shortcodes too, would like to have a go at this. Can I please get to work on this? (Assigning for now, if its not feasible do let me know, i dont want to cause proiblems with anyone)

/assign

sftim commented 10 months ago

@steve-hardman I recommend you liaise with @coder12git to check you're not both trying the same thing.

Of course, if you'd like to work collaboratively, that could be ideal.

coder12git commented 10 months ago

I'm learning different aspects of website repo and learning about shortcodes too, would like to have a go at this. Can I please get to work on this? (Assigning for now, if its not feasible do let me know, i dont want to cause proiblems with anyone)

/assign

I am already working on it, i mentioned too that i will be working on it, you can go with any other issues and can help us in reviewing this PR

coder12git commented 10 months ago

/assign

steve-hardman commented 10 months ago

Lately, I have seen this repository has turned into a competitive space, with everyone assigning themselves to issues very quickly. It seems to be heading towards ineffective collaboration, but that's a topic for another time. I sincerely apologize for any confusion.

Wishing you guys a very Happy New Year!

steve-hardman commented 10 months ago

Apolgoies for the confusion @coder12git. I have removed by assignment.

sftim commented 5 months ago

I welcome reviews on https://github.com/kubernetes/website/pull/46232

sftim commented 2 months ago

Also, check out https://github.com/kubernetes/website/issues/41171

sftim commented 4 weeks ago

What do we think the next steps are here? Maybe pick a subsection of the English docs and plan work to migrate that subsection over?