Skip to content

Adding a FAQ Entry

Brian King edited this page Nov 8, 2017 · 2 revisions

How to Create a FAQ Entry on the OSLC Site

  1. Firstly, clone the 'OSLC/oslc-site-hugo' repository.
  2. Create the markdown file for your post. The filename can has to be faq + a number, e.g. faq7.md.

There are 2 ways to create the file:

  • copy an existing post (in the 'content/about/' folder) and change the information in the post. This means changing the value of the metadata fields.

OR

  • From the repository root, type 'hugo new about/filename.md' replacing filename with the name of the entry. The new file will be in the 'content/about' folder.
  1. Add the post information. Only metadata is required, no extra content below.
  2. Once you are satisfied the entry is ready, create the pull request with your changes for review.

Entry Metadata

  • categories - a comma separated list of categories that the entry falls into, each one in double quotes
  • date - the date of the entry, i.e. when you add the question
  • tags - a comma separated list of tags for the entry, each one in double quotes
  • title - The question
  • answer - The answer to the question