SUSE / doc-styleguide

SUSE Documentation Style Guide
https://susedoc.github.io/doc-styleguide/main/html/style-guide/
Other
14 stars 2 forks source link

Add section about the task element #233 #296

Open dariavladykina opened 5 months ago

dariavladykina commented 5 months ago

This PR aims to add a subsection about the task element to the Structure and Markup chapter #233

dariavladykina commented 5 months ago

Hi @tomschr , could you please have a look? I get strange output in the example, although I tried to copy the structure that you used in your example. image

tomschr commented 5 months ago

Yes, that's to be expected. :slightly_smiling_face: The task element is only partially supported by the stylesheets. There is still an open issue for that, see openSUSE/suse-xsl#307. I haven't worked on this since Nov 2022.

Maybe my memory is wrong, but we haven't discussed it in the SLE Writer's call, have we?

As such, before we describe it, we should first define when and how we use it. Additionally, task comes also with some limitations so we should be aware of those:

Therefore, it might be useful for a smaller task or if you split a huge task into small sub-tasks. However, that could impose some structural changes that is not always wanted.

On the other side, it could be beneficial is you want to enforce a specific structure.

Therefore, I'd suggest to discuss this in a broader audience if we want to live with the restrictions and use it, or if the existing structures are enough for us.

jfaltenbacher commented 5 months ago

I have worked a lot with tasks elements before and never felt limited. I am in favor of having it

janajaeger commented 5 months ago

I'm fine with our without it. It might be an additional crutch for writers to come up with a decent structure. Those who feel limited, can still opt to go without ;)

cwickert commented 5 months ago

+1 for having it. I think it could be applied to 99% of our topics and will further unify them (if used consistently). And if the structure doesn't fit, well, you can still go without it.