#517 QD3 What categories do Quick Docs articles belong to (how-to, tutorial etc.)
Closed: moved a year ago by hankuoffroad. Opened a year ago by anthonymcglone.

Based on discussion at https://discussion.fedoraproject.org/t/project-quick-docs-improvement/44322, it was suggested to find what categories each Quick Doc article belongs to, based on discussion here https://discussion.fedoraproject.org/t/classification-of-all-the-content-on-the-docs-website-contribute-if-you-can/38398

It seems there are four types of article, how-to, tutorial, explanation and reference-guide.

The thinking behind classifying the articles into these categories seemingly is to relocate the quick docs to the new Fedora docs website. See https://discussion.fedoraproject.org/t/fedora-docs-design-work/40062

Additionally, it might be worth creating a list of tags for each article, as mentioned in the design of the new website in the link above. For instance, an article about boot loading could have tags like "GRUB" "bootloader" "BIOS" "UEFI" etc.


We need a way to categorize or tag the articles by which filtering is possible on the one hand, but which can also be displayed on the other.

Probably, this requires to develop a plugin for Antorra.

Possible approaches:
Antorra Document Attributes Reference , there exist 'keywords' (as HTML Meta elements) or
Title and Metadata and there exist custom attributes (see Define and Modify Attributes and Page Attributes ). There is nothing "ready to use".

@pboy so it sounds like there are two (or three) parts to this ticket? Would you correct my understanding.

1) It requires going through the articles and seeing what category they fall into (Workstation, Server, Coreos [1], How-To, Tutorial, Reference, etc.) [1]is there a defined list of these categories somewhere so it could be used for the manual classification?

2) Update the Quick Docs articles like it mentions in "Define and Modify Attributes" with those categories/attributes (I assume this part will be done manually)

3) Then the new Antorra plugin comes in? Will it assist in generating the QuickDocs website or something (I mean will it displays the articles by their category? Instead of how it does it now?)

Apologies for all the newb questions.

Fully revised articles have attributes with all metadata. Docs team need to combine metadata update with actual content update. Closing this.

Metadata Update from @hankuoffroad:
- Issue close_status updated to: moved
- Issue status updated to: Closed (was: Open)

a year ago

Login to comment on this ticket.

Metadata