worldbank-transport / rah

Proof of concept for the Rural Accessibility Hub

Rural Accessibility Hub

This project is part of the Rural Accessibility Map. The RAM toolset is used to generate insight into the accessibility of rural populations. Once people generate analysis in their instance of RAM, they can export those results and share them with a wider public.

Moderation documentation

• publish new content
• edit existing content
• remove content

rah's Issues

Make structure Prose ready

Todo:

• commit initial Prose config - @olafveerman
• flatten contact structure on RAM - @danielfdsilva
• generate JSONP files with metadata (countries, topics, authors) - @danielfdsilva
• look into date field

Allow users to publish analysis without underlying data

Instead provide contact information so people can request data.

Notify moderators

Find a way to notify the RAH moderators. Possibly:

• create a team on Github
• cc them in the PR message

Style project details

Style empty states

Add domain name

http://hub.ruralaccess.info

Go responsive

Components:

• Global menu
• Filter menu
• Projects card list
• Inpage actions
• Map and legend
• Project aside and main content
• Footer contents

Technical approach and workflow

We propose to implement the Rural Accessibility Hub using a static site generator like Metalsmith, and relies on Github to host the site and provide a content moderation workflow. This approach results in a website that doesn't need a backend, and is performant, secure and cost efficient to maintain.

Github is built and optimized to collaborate on code. The exact same workflows that teams use to review and approve code contributions, can be used to moderate content. Add the workflows that automatically publish the content to the live site, and we have a robust backend for the Rural Accessibility Hub that requires no further infrastructure.

Workflow

The general workflow with this approach is:

1. A user that has run analysis in RAM chooses to export the project results to the Data Hub
2. During export, the user provides additional information about the analysis
3. The application automatically creates a GitHub Pull Request with this information
4. The team that manages the RAH gets a notification and can accept or reject the Pull Request

1. Export results to RAH

After a user runs analysis for a scenario in RAM, they can choose to export the project results to the Data Hub.

2. Provide additional information

On export, the user provides additional information that will be used to provide context about the analysis on the Data Hub.

3. Create Pull Request

Using the information provided by the RAM user, the backend automatically creates a Pull Request in the repository for the Rural Accessibility Hub on Github. This Pull Request contains:

• a markdown file with the user provided content from the form
• the results of all the scenarios of the project in CSV and GeoJSON format

This Pull Request will generate a notification to all users on the RAH moderation team. The Pull Request message will also contain a quick link to Prose to make it easier for content moderators to edit the file.

4. Handle Pull Request

The moderation team can merge (accept) or close (reject) the Pull Request. If there is a need to make changes to the markdown file before merging the PR, they can do so through Prose.

When the PR is merged, Circle will build the site and push the new version live.

Add guidelines

Add moderation guidelines to:

1. remove a project
2. edit the content of a project

Include map in project page

• Structure and style map
• Structure and style legend

Document the publishing process

Create documentation about how content can be published on RAH.

One important things to include, is that after closing or merging a PR, the branch needs to be deleted. (see: WorldBank-Transport/ram-backend#227 (comment))

Missing countries.json

Prose will not load because countries.json gives a 404
GET https://rah.surge.sh/assets/content/countries.json?callback=countries_cb 404 (Not Found)

Update the Readme

With:

• good explanation about the purpose of the project
• links to editing guidelines

Fix copy to clipboard field appearance

Structure and style static pages

Functional prototype

The Rural Accessibility Hub will be a global hub to publish accessibility assets and analysis generated by instances of RAM. Pending a more thorough discovery process around needs and requirements, we will implement a functional prototype in static HTML that will showcase a basic feature set of this hub.

Catalog

The catalog contains an overview of published scenarios. This page could feature a map with project locations:

Results page

Each study has a dedicated page with basic metadata, a long description about the project, and download options with the final analysis (CSV with origin level results).

cc @ricardomestre @danielfdsilva