From 6963519bd5942118ff2dc8fb0539aebffc6042f6 Mon Sep 17 00:00:00 2001 From: Antoine Lambert <anlambert@softwareheritage.org> Date: Tue, 26 Nov 2024 10:36:46 +0100 Subject: [PATCH] README.md: Add info about dynamic generation of FAQ page in SWH website --- README.md | 7 +++++-- 1 file changed, 5 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 99c0673..93344e1 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ # Software Heritage's FAQ repository -This repository is dedicated to writing the collection of Frequently Asked Questions. +This repository is dedicated to writing the collection of Frequently Asked Questions. Ambassadors and contributors can do MR or add issues dedicated to the FAQ. - the faq.md file can be easily exported into html with the correct tags per question - concerning the devs/users/sys-admins FAQ, they will be directly edited in the docs @@ -11,5 +11,8 @@ We have now a significant amount of material from interviews, newspaper articles From this material, we compiled a list of frequently asked questions with the typical answers we provide. E.g.: what is software source code? why archiving software source code? how do you decide what to archive? do you also archive binaries? hey, the Library of Alexandria went up in flames, how do you plan to avoid this happening to you? etc. etc. -The full FAQ is available on faq.md, section 1 to 5 are already online on https://www.softwareheritage.org/faq/. +The full FAQ, with some unpublished content waiting for review, is available on [faq.md](faq.md) while the published FAQ is available on [20240701_faq.md](20240701_faq.md), section 1 to 5 are already online on https://www.softwareheritage.org/faq/. +The content of each FAQ page (one per supported language) located at https://www.softwareheritage.org/faq/ is dynamically generated from associated markdown file in that repository, every change pushed to is automatically taken into account when refreshing the published FAQ page. + +To be noted, for a proper display of a FAQ page in the main Software Heritage website, the associated markdown document should start with a level 2 heading (`## section title`). \ No newline at end of file -- GitLab