Update documentation for mr4 - #63
Draft
CollinBeczak wants to merge 15 commits into
Draft
Conversation
Remove the pages for features that are not coming back, and move the four whose features have now been built into the sections they belong to: Setting The Basemap Layer For Your Challenge -> User Settings Challenge Managers: filtering tasks by properties -> Challenges Templating in Challenge Instructions -> Challenges System-Notice Management -> Server Admin Each moved page drops its "not implemented" notice and is rewritten to describe what the frontend actually does now, rather than what MapRoulette 3 used to do: - The challenge basemap page covers the bundled base layers and custom XYZ templates, and spells out the challenge > user > last-picked precedence. - The property filtering page describes the AND/OR rule builder and the operators the backend can search on, replacing the old data-type-first flow and comma-separated values. - The templating page notes that answers are saved against the task, and how short codes are told apart from Markdown links. - The system-notice page describes the backend-served notices file rather than the REACT_APP_SYSTEM_NOTICES_URL frontend setting, which no longer exists. Deleted: Reviewing, Using Mapillary Images, Styling Task Features. The one link to Reviewing, in Using MapRoulette Tags, becomes plain text. Permalinks are slug-based, so moving pages between sections keeps every inbound link working. "Not Implemented Yet" is down to Tag Fix Challenges and Following.
Two pages for people arriving from MapRoulette 3, in a new sidebar section
placed after Getting Started.
"Moving from MapRoulette 3 to MapRoulette 4" is a checklist of what to
expect, grouped by who is affected: mappers, challenge managers and server
administrators. Each row says what you did in MR3 and where that stands now,
linking to the page that covers it. It leads with the reassurance that the
server is the same one, so nothing anybody created needs migrating, and
points at the HTTP API for the cases where a feature left the frontend but
not the data model. Content is drawn from the notices already scattered
through the site, so the two stay consistent.
"What changed in these docs" covers the documentation itself: the move off
the /en-US/ URL prefix, how the six old sections were redistributed, the
seven pages that were removed and why, the pages that graduated out of Not
Implemented Yet, and why the partial translations were dropped rather than
carried forward.
The `{{#mapZoom}}` example is wrapped in raw tags, as on the mustache page,
so Liquid does not try to parse it.
Nine "not implemented" notices came off pages whose features have been built: project managers and team project roles, preferred MapRoulette tags, the OSM/External Id property, task reference layers, challenge exports, bracketed mentions, per-notification email preferences, custom base layers, and workspace mustache tags. Following moves out of Not Implemented Yet into Teams, keeping a narrower notice: the follow relationships, lists and privacy setting all work, but the combined activity timeline of everyone you follow does not exist. The base layer and map layer management pages describe adding your own XYZ or WMS layer, including that such layers live in the browser rather than on the server, so they do not follow a mapper between devices and nobody else sees them. The migration guide's tables are rewritten to match, since ten of its rows described these as missing.
Nine rows described features that behave exactly as they did in MapRoulette 3 — bracketed mentions, per-notification email preferences, challenge basemaps, project managers and team roles, preferred MapRoulette tags, the OSM/External Id property, workspace mustache tags, task reference layers and challenge exports. A row saying "available again" tells a migrating user nothing, and a long table of non-differences hides the real ones, so they are gone. Three rows said "available again" where that was not quite true, and now name the remaining difference instead: custom map layers are stored per browser rather than on the account, the property filter has no comma-separated "Add Value" shortcut, and instruction templating still does not render the OSM element and viewport short codes. The introduction now says the page lists only what differs, so a reader who cannot find their feature knows that means nothing has changed rather than that the page is incomplete.
Custom map layers save to the account rather than the browser, following a mapper between devices; the base layer and map layer management pages say so, noting the signed-out case still falls back to the browser. The property filter page documents the comma-separated values shortcut, the Following page mentions the combined activity feed, and the comment short codes page drops its notice now that OSM element and viewport codes render in comments as well as instructions. The migration guide loses those four rows. Nothing about them differs from MapRoulette 3 any more, so there is nothing for a migrating user to learn.
Tag Fix Challenges moves into Mapping Tasks and describes what the editor now does: the proposed tags are applied in iD as unsaved edits for the mapper to review, correct or undo and then save as their own. It keeps one notice, for the part that is still true — cooperative challenges, and so tag fix challenges, cannot be created from the interface. That empties the Not Implemented Yet section, so it is removed along with the appendix_sections config it was the only member of. The layout already guarded on that key, so nothing else changes. The migration guide's tag fix row and both pages' references to the retired section are updated to match.
The Tag Fix page still described MapRoulette 3's flow — a suggested change presented at the top of the screen with Yes and No buttons — which has not existed for some time. It now describes what actually happens: the editor opens on lock with the suggestion applied as unsaved edits, the task panel shows the suggestion before the editor opens and your own pending edits after, and Reset restores the suggestion. Bundling and the create/delete limitation are covered too. The editing page gains the controls that came with the floating panel: that it can be dragged and remembers where you put it, that the unsaved-changes count opens a list of what is actually pending, and that Focus now hides the surrounding features rather than dimming them — including from clicks, which is the point of it. The task screen page and the migration guide's tag fix row are updated to match.
Plugins are not ready to be documented yet, so the page added in the last commit is removed. Nothing linked to it. Two mentions I had added elsewhere go with it: the migration guide's server-administrator bullet, which also named Reviewing as a plugin, and "plugin management" in the Super Admin page's list of placeholder screens.
Comparing every surviving page against the version on main turned up three things worth having back. The comment short-codes page was still written in the past tense — "were displayed as links", "could be fully spelled out" — left from when it documented something the frontend did not do. It does now, so the page describes it in the present, notes that short codes work in challenge instructions as well as comments, and says that ordinary Markdown links are left alone. The bracketed mention form for usernames with spaces is written up for the first time. The old teams page made a point that survived nowhere: a member's role on a team has no bearing on the permissions that team confers on a project. Every member gets the same project permissions whatever their team role, which is not obvious and is easy to get wrong. Following gains the blocking section, matching the feature added alongside this, including that blocking only removes someone from your followers' activity feed rather than hiding your editing from them. The rest of what shrank — the widget workspace, editor-layer-index configuration, the old property-filter flow — describes MapRoulette 3 behaviour that is genuinely gone and already noted as such.
- Drop the review MR tags, which the challenge form no longer offers, and describe the single task-completion list that remains - Move Task data up under Basic information, matching the form's order - Replace the Properties and OSM tabs with the Data tab and its Properties, GeoJSON and OSM feature sections, and call the first tab Instructions, which is what it has always been labelled - Rewrite challenge reporting: reports now go to the MapRoulette administrators and are triaged under Super Admin, not filed as public GitHub issues, so the VITE_GITHUB_ISSUES_API_* settings are gone
The Mapillary, KartaView and OSM data overlays are gone from the task map, but mappers can still reach them from inside iD, so say that instead of leaving both pages at "not available".
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
No description provided.