oasis-open / csaf-documentation

OASIS TC Open Repository: A GitHub repository for management of non-normative information about the work of the CSAF Technical Committee, including documentation
https://oasis-open.github.io/csaf-documentation/
BSD 3-Clause "New" or "Revised" License
19 stars 10 forks source link

Add FAQ section #18

Open tschmidtb51 opened 2 years ago

tschmidtb51 commented 2 years ago

It would be beneficial to add a FAQ section. Questions could be:

santosomar commented 2 years ago

I will bring this during the TC monthly meeting tomorrow (Aug 25, 2021) to get more members to contribute to this FAQ. I will start a section in the website soon. We can probably use this issue to get feedback from the TC.

santosomar commented 2 years ago

A few additional questions:

santosomar commented 2 years ago

Created a placeholder here: https://oasis-open.github.io/csaf-documentation/faq and https://csaf.io/faq should redirect to it.

tschmidtb51 commented 2 years ago

For question 2, I would like to add an additional sentence:

It also specifies the distribution and discovery of CSAF documents.

tschmidtb51 commented 2 years ago

@santosomar : It looks like something got mixed up here as FAQ links to https://docs.oasis-open.org/csaf/csaf/v2.0/csd01/csaf-v2.0-csd01.html and CSAF 2.0 to https://oasis-open.github.io/csaf-documentation/faq#. A similar problem exists on the main page.

santosomar commented 2 years ago

Fixing now...

santosomar commented 2 years ago

Fixed the link wth: https://github.com/oasis-open/csaf-documentation/commit/c36cdeb15f340a34b74641f8067bb567307aa650

Will leave this open until we collect more ideas for Questions and Answers.

santosomar commented 2 years ago

https://csaf.io/faq is also now active (redirect) and csaf.io/videos

santosomar commented 2 years ago

It also specifies the distribution and discovery of CSAF documents

@tschmidtb51 - thank you! Added in https://github.com/oasis-open/csaf-documentation/commit/61468ea5d83fac1144c3cc3056ce4df0639144d7

tschmidtb51 commented 2 years ago

@santosomar Do you use a specific tool to generate the website or is it all done manually?

santosomar commented 2 years ago

I mostly use Mobirise for the look and feel. (I am lazy and don't want to deal with CSS, etc.)