docs icon indicating copy to clipboard operation
docs copied to clipboard

Add faq directory structure

Open StefanJum opened this issue 2 years ago • 2 comments

This pr adds a directory structure for common issues and faqs, similar to what we have for the hackathon sessions. All the content is placed inside docs/common-issues/content and refered in docs/faq.md via the readfile shortcode.

Likely we will have another front page where common issues will be added since they refer directly to issues, not questions, but I would suggest we keep the content in the same docs/common-issues/content directory and we name the issues something like Common-Issues_Issue-Name.md, while the name of the frequently asked questions will look like the ones in this commit: Frequently-Asked-Questions_Question-Name.md. Any other ideas on this are welcome.

Content is taken from #31.

Signed-off-by: cristian-vijelie [email protected] Signed-off-by: Stefan Jumarea [email protected]

StefanJum avatar Sep 03 '22 11:09 StefanJum

Hi @StefanJum,

we defintely need a FAQ section for the docs site! I'd like to structure it, however, with a little more integration into the Hugo partials system. I think creating a new file for each FAQ item is fine, considering that there may be many items and any item can be paricularly verbose.

As a result, an FAQ page should be added as custom page type with custom archetype. The page can iterate across each file item to generate a prompt as well as a permalink which takes you to the full explanation page.

Additional notes:

  • I'd rename common-issues folder to faq.
  • Each file should be the "slug" of the URL name, e.g.: unikernel-vs-container, and so: content/en/faq/unikernel-vs-container.md.
  • Each file should contain the newly defined archetype which must include both the question and the answer:
    ---
    question: "What's the difference between a unikernel and a container?"
    ---
    Unikernels are VMs.  For more information, please read the [...]
    
  • The main FAQ page should then be integrated into the layouts/ dir where each file's archetype is parsed iteratively and the question is laid out as a URL. This means adding a new FAQ only requires adding a new file, and not updating a list anywhere else.

nderjung avatar Sep 04 '22 11:09 nderjung

Thanks a lot, @nderjung. I am not very experienced with hugo so it may take some time, but I will look into that and let you know how it goes.

StefanJum avatar Sep 04 '22 13:09 StefanJum

Superseded by #391

StefanJum avatar Jul 20 '24 09:07 StefanJum