Skip to content

Latest commit

 

History

History
97 lines (60 loc) · 2.51 KB

README.md

File metadata and controls

97 lines (60 loc) · 2.51 KB
Raw

ufdl-datasets

Nikola website making the UFDL datasets publicly available.

The generated site is available here:

https://datasets.cms.waikato.ac.nz/ufdl/

Installation

For developing the site locally:

  • create virtual environment

    virtualenv -p /usr/bin/python3 venv

  • install Nikola

    ./venv/bin/pip install nikola aiohttp watchdog

Adding content

  • Nikola handbook
  • Content is written in reStructured Text
  • Pages are located in pages
  • News items (aka blog posts) are located in posts; should have a date prefix in the name

How to add/list datasets

  • define an ID for the dataset, e.g., dataset1

  • Dataset server

    • log into datasets.cms.waikato.ac.nz
    • change into /var/www/html/ufdl/data/
    • create a sub-directory according to the ID
    • upload relevant data archives

  • Nikola

    • files/conversion

      • create a sub-directory according to the ID
      • upload any data/script/etc that is required for converting the original data

    • images

      • add sample image to be used as thumbnail on image page (use ID.jpg/png for better identification)

    • pages

      • add page for the dataset with ID.rst as name
      • use dataset ID for the page slug as well

    • Update the relevant pages (update timestamp as well!):

      • index.rst - contains links to domain pages that list/link the actual datasets
      • image-classification.rst - page for listing image classification datasets
      • image-segmentation.rst - page for listing image segmentation datasets
      • object-detection.rst - page for listing object detection datasets
      • speech.rst - page for listing speech datasets

    • When a new domain page is required

      • create page DOMAIN.rst in pages
      • update NAVIGATION_LINKS in conf.py to include the new domain page

    • Add a news item in the posts directory, linking to the new dataset

    • Deploy the site (see below)

How to announce datasets

  • Add a news item in the posts directory (YYYY-MM-DD-title-of-post.rst)
  • Deploy the site

Serving

The following command not only serves the website on localhost:8000, but also detects changes in files and automatically rebuilds the website:

./venv/bin/nikola auto

Deploying

Use the following command to build and deploy the website:

rm -R output && ./venv/bin/nikola clean && ./venv/bin/nikola build && ./venv/bin/nikola deploy