Administrator’s Guide

This page describes how to administer a Frictionless Research Exchange (FRX) Challenge.

Authoring website content¶

The FRX Challenge platform is built on top of the Django framework. You can author content for your challenge website using Markdown and HTML.

Django Admin¶

If your website user account has admin permissions, then the Django Admin interface is available at https://<challenge-website-name>/admin. Please contact your Django administrator if you require access.

Under the Web > Pages section, you can create and edit multiple pages using the Django Admin interface.

Pages

The Pages section contains the necessary fields to author pages on the website.

title (string)

The title of the page.

slug (string)

Slug used to refer to the page’s URL.

Navbar order (integer):

Ordering of this page on the navbar. Leave unset to hide from navbar

Is home (boolean)

Use current page as the home page. Only one page can have this enabled at any given time.

Mimetype (TextChoices)

Mimetype used to render the page.

HTML (text/html)

HTML content.

Markdown (text/markdown)

Markdown content.

Content (text)

The content of the page.

Header content (text)

Content to be displayed in the header of the page.

Uploading data to a storage bucket¶

If your challenge requires access to a large dataset, then you can upload your dataset directly to a cloud storage bucket. The FRX Challenge platform supports using Google Cloud Storage for this purpose.

For a brief overview of cloud object storage, see the 2i2c docs – Cloud Object Storage.

Identity and Access Management (IAM)¶

You must have a Google account to authenticate with and the necessary permissions to access the bucket. Please contact your GCP project administrator to request access.

If you are using the gcloud command-line tool, authenticate with your Google account using the following command:

gcloud auth login

Uploading data¶

The bucket name is provided by your GCP project administrator and is of the form

gs://my-bucket-name

You can upload data to the bucket using the Google Cloud Console or the gcloud command-line tool.

Using the gcloud command-line tool¶

Use the following command to synchronize a local directory with a bucket:

gcloud storage rsync -r /path/to/local/directory gs://my-bucket-name