Create FAQ section in the docs

[anuveyatsu]

As a datahub user I want to see the FAQ doc to quickly find some common answers.

Tasks

• [x] write a document
• [x] publish on the datahub/docs
• [ ] define the mechanism to update the FAQ from the user questions we can update FAQ using our bot:

  +faq:
  Q: what is "A"?
  A: It is the "B"

  :grinning:

Acceptance criteria

• [ ] on the /docs page there is FAQs page at /docs/faqs

Analysis

Questions people have asked: Brook on data validate sep 2017:

Will keywords property be used? Will description property in datapackage.json be used to populate the Showcase description? How does that relate to the Readme section? Will homepage property be used? I'm using it to link back to the original dataset page on UKDS. Related to homepage, a single source is printed to the showcase page as part of the dataset summary. Currently, this doesn't link to a source.path, and it uses the first item's source.title as a title attribute for the link. The datapackage spec allows for multiple sources and I've used it to link back to all resource files associated with my datapackage on UKDS (including non-tabular support files), so it seems odd to display just the first one. Will additional admin tools be available for the Showcase page? Currently page is 'unlisted', is there a way to change this to public? Are my datasets listed anywhere, I can't see my 'unlisted' datasets on my profile page or dashboard.

Other:

• Can I get an organization account/username rather than my personal username?
• Is there a way I can upload a dataset and be part of an organization

[rufuspollock]

@anuveyatsu i've added some existing questions we've been asked. @AcckiyGerman and others may be able to think of others.

Small comment re issues: we seem to have a "bug style" reporting model now rather than user stories and acceptance criteria. For something like this (a new feature) user stories would be better. I wonder if we should shift the template back to old style or at least use it for these types of issues. Could you add user stories and acceptance criteria for this.

[AcckiyGerman]

We should also add terms definitions in the FAQ:

• dataset is...
• datahub is...
• descriptor is...
• etc

[zelima]

@anuveyatsu This looks good but how can I get there? Could not find the button in navbar, either section on docs/page

[anuveyatsu]

@zelima there is a section "Misc" in the docs page, you can find it in the bottom of the page: https://datahub.io/docs and here is the page itself https://datahub.io/docs/faq

I think we can close this issue for now as FIXED. Adding a button into navbar should be something separate as we probably want to have a drop-down, e.g., "Help" that will contain "Docs", "Chat" and "FAQ" links.

[zelima]

@anuveyatsu button was just an example. It's really hard to find when you don't know where to search. we can simply add FAQ to the list of the links in the footer - that's the place it usually it lives on other websites

[anuveyatsu]

@zelima done (see the commit above). Let's wait when it's deployed and close this issue.

[anuveyatsu]

FIXED - we now have a link in the footer.