Skip to content

FAQ module #4

Description

@overlordtm

Implement FAQ module.

Current state:
FAQ identifiers are stored in github.com/sledilnik/website/blob/master/src/content/faq.js and actual strings are stored in i18n jsons (src/locales/*.json). In JS, everything is compiled into searchable database, using fuse for client side search

Desired state:

  • FAQ will be available via APi endpoint e.g. /api/v1/faq
  • Import current questions in sl and en to database
  • API should return translated questions for given langiuage give as query param (lang) or Accept-Language header (query param overrides header).
  • Consider FAQ questions have to be ordered and grouped by sections (see how does current FAQ looks like)
  • Search will remain client side, so API return all objects
  • Add option to add keywords to question, for search

Example API response should look like:

{
  "meta" {...},
  "objects": {
    {
      "title": "Section title",
      "faq": [
        { "question": "Translated question", "answer": "translated answer", "keywords": ["some", "keyworrds", "for", "search"] }
        ...
        ]
    }, ...
}

Metadata

Metadata

Assignees

No one assigned

    Labels

    enhancementNew feature or request

    Type

    No type

    Fields

    No fields configured for issues without a type.

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions