OvertureMaps / OvertureMaps/stac

[Investigation] Should we generate & link to HTML versions of each STAC file?

Open
#79 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Rust
Stars
39
Forks
3
Avg merge
4d 18m
Merged PRs (30d)
7

Description

Motivation

From STAC best practices (emphasis mine):

One of the primary goals of STAC is to make spatiotemporal data more accessible on the web. One would have a right to be surprised that there is nothing about HTML in the entire specification. This is because it is difficult to specify what should be on web pages without ending up with very bad looking pages. But the importance of having web-accessible versions of every STAC Item is paramount.

The main recommendation is to have an HTML page for every single STAC Item, Catalog and Collection. They should be visually pleasing, crawlable by search engines and ideally interactive.

Right now...we don't have that. And the STAC Browser is great, but its a SPA that generates content, and isn't crawlable by search engines and has a slew of accessibility and interaction limitations.

If we used a tool like https://github.com/lowlydba/docusaurus-plugin-stac or similar, we could generate human-readable STAC files & link back to them from the core .json files.

Demo: https://lowlydba.github.io/docusaurus-plugin-stac/stac/

Is this worth doing?

..is the question

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Review the STAC best-practices passage and the linked docusaurus-plugin-stac demo first, then compare them with this repository’s core .json files. Done means producing a clear recommendation on whether to generate crawlable HTML pages and link them from each STAC file, including the expected scope and approach.

Written by the indexing model from the issue text.

Assessment

Tech stack
json
Domain
documentation, web-dev
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Quiet
Clarity
Needs clarification
Newbie friendliness
30/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.