onaio/gisida

Ability to publish a single layer in an iframe

Open

#9 opened on Nov 22, 2017

View on GitHubContributor guide
 (2 comments) (0 reactions) (0 assignees)JavaScript (4 forks)auto 404
:water_buffalo: coreLayer Buildergood first issue

Repository metrics

Stars
 (13 stars)
PR merge metrics
 (PR metrics pending)

Description

As a user, I would like to be able to share a single layer in an iframe.

Since it will be a single layer, there will be no map component.

Once we get this working we can explore ways to combine multiple layers in an iframe share.

Rationale

The initial goal is to provide a way for us to start share hosted layers (promoting the mapviz spec). We will try and start to get these embedded on the HDX (humdata.org) site.

This will also be a way for us to start promoting / getting previews of gisida in blog posts, etc.

Assumptions

  • This will point to a gisida JS we will host
  • The maps will initially point to our mapbox tiles. Obviously, they can point at their own mapbox account in their spec.

Design In the footer of the iframe, we'll want a gisida logo.

screen shot 2017-11-22 at 12 06 01 pm

We could link to the source (like how they do it below). This would show the details we have in the credits). It could also provide a link to the hosted mapviz spec json file.

screen shot 2017-11-22 at 12 01 03 pm

Contributor guide

Research direction
Implement iframe embedding for a single layer without the map component. Design a footer with gisida logo and link to source. Consider how to handle multiple layers in future.
Tech stack
javascript
Domain
frontend
Issue type
Feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-2 days
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Mostly clear
Prerequisites
JavaScriptiframeMapbox GL
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
60