Docs: Improve documentation around GeoJSON

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

Nobody has claimed this yet.

Assessment

Difficulty
4/5
Estimated time
3-5 days
Newbie friendliness
45/100
Issue type
Documentation
Clarity
Mostly clear
Activity status
Stale
Domain
documentation

Research direction

Start by reading the existing pages listed in the issue: Line-by-Line GeoJSON Format, Create a Challenge with GeoJSON data, Hosting Remote GeoJSON with Gists, Styling Task Features, and Task Attachments. Use them to define the recommended format and organize a central GeoJSON entry in the documentation navigation. Done means the relevant pages are connected, the requested guidance and CLI mention are covered, and the GeoJSON-specific material is consolidated.

Written by the indexing model from the issue text.

Description

References https://osmus.slack.com/archives/C04M1NHPEQY/p1740551156419729, https://osmus.slack.com/archives/C04M1NHPEQY/p1740582840392009

I propose to add to the docs about how the GeoJSON for MR can and should be defined and use this opportunity to restructure some docs around GeoJSON.

Suggestion:

  • Create a dedicated entry page that explains the supported and explicitly the recommended format for uploading date to MR and for the format that APIs should return when using the "external URL" option.
  • Given the structure of the navigation, it might be easiest to set up a headline "GeoJSON" and add all the pages above in this section
  • Most of existing pages could mostly stay as is but be linked from that central page – and link back to it as an introduction sentence that ties it together.

Status quo:

Title URL Comment
Line-by-Line GeoJSON Format documentation/line-by-line-geojson/ Clarify the deviation from the GeoJSONL standard: MR requires FeatureCollections, not Features; Maybe mention lacking support in QGIS/Placemark and ideally how to test this MR format in QGIS software
Create a Challenge with GeoJSON data screencasts/create-a-challenge-with-geojson-data/ Did not watch the screencast but I think it uses the cli which should be mentioned on the page
Hosting Remote GeoJSON with Gists /documentation/gists-for-remote-geojson/ This page should link back to explain the format of the GeoJSON in the Gist
Styling Task Features /documentation/styling-task-features/ Extract the part on GeoJSON to the new page that is linked in the GeoJSON section
Task Attachments  /documentation/task-attachments/ Don't know what that is/does but should be part of the the new GeoJSON section as well
Dominant language
SCSS
Stars
5
Forks
8
No merged PRs in 30d

Contributor guide

No contributing guide indexed for this repository

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.

More from maproulette/docs

All issues in maproulette/docs

Similar issues

More Documentation issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.