GithubHelp home page GithubHelp logo

maproulette / docs Goto Github PK

View Code? Open in Web Editor NEW
5.0 5.0 7.0 63.12 MB

A documentation site for learning MapRoulette.

Home Page: https://learn.maproulette.org

License: MIT License

JavaScript 53.91% CSS 3.93% HTML 1.01% Nunjucks 41.16%

docs's People

Contributors

bsvensson avatar cj-malone avatar collinbeczak avatar democat3457 avatar homersimpsons avatar jschwarz2030 avatar mvexel avatar nrotstan avatar ryanscherler avatar

Stargazers

avatar avatar avatar avatar

Watchers

avatar avatar avatar avatar avatar

Forkers

nrotstan bsvensson mvexel cj-malone democat3457 tordans

docs's Issues

Document how to update translations

Do we have to update the strings like

docs/src/translations/en-us.json

Line 31 in 4218de8

"CreatingCooperativeChallanges.content1": "Cooperative Challenges allow in-progress (uncommitted) mapping work to be packaged with tasks so that mappers don't have to do all the work themselves from scratch. When a mapper chooses to edit the task in MapRoulette, the in-progress work will automatically be loaded into the mapper's editor so that they can verify and complete the work as needed.\n\n> Note: JOSM is currently the only supported editor for Cooperative Challenges, but integration with additional editors is under way\n\nAside from the initial editing work being automatically loaded into the mapper's editor, the mapping workflow for Cooperative tasks is otherwise identical to normal tasks: the mapper still chooses to Edit the task, they still perform the editing work in their editor, they still upload and commit their work to OSM through their editor, and they still mark the task as Finished or another appropriate status in MapRoulette when complete.\n\n### Creating Cooperative Challenges\n\n#### With the `mr-cli` utility (recommended)\n\nThe simplest way to create cooperative challenges is with the [mr-cli](https://www.npmjs.com/package/@maproulette/mr-cli) command-line utility, which can generate challenges from saved JOSM (.osm) or OSM Change (.osc) files. See the tool's documentation for details and examples of use.\n\n#### With GeoJSON\n\nCooperative challenges can also be created by including additional data with each task in the GeoJSON, including an [OSMChange (.osc)](https://wiki.openstreetmap.org/wiki/OsmChange) file that represents the in-progress work that is to be loaded into the mapper's editor for the task. The additional data should be included in a `cooperativeWork` object associated with each task's `FeatureCollection` in the challenge's [line-by-line GeoJSON](/documentation/line-by-line-geojson/) file.\n\n> :warning: Only [line-by-line GeoJSON](/documentation/line-by-line-geojson/) is supported for cooperative challenges. If you use a traditional GeoJSON format, your cooperativeWork section will simply be ignored and you will end up with normal tasks instead of cooperative tasks\n\nThe structure of the `cooperativeWork` object is designed to be flexible to support various options, formats, and encodings in the future, but at the moment only a very specific combination of values is supported.\n\nThe following example demonstrates the structure, shown here over multiple lines for readability.",
manually inline or is there some UI?

Please add some docs that explain how to update the files.

Spanish language docs

There is some interest in starting to translate the docs at learn.maproulette.org (this repo) into Spanish. Please chime in here if you are interested in helping out!

Technical documentation in english only

I tried to contribute to the docs just now and it is just not fun. (See also #38.)

I wonder if one step to make this easier where to keep all those really technical docs in english only.
IMO it is far more important to have great english docs about technical stuff that can be updated super easily that it is to have them translated.

This suggestion does not apply to user facing docs that explain the UI and such, this is only about the API and data structure docs.

Another idea would be to switch to the great static side generator astro which has great i18n support using pages build in https://docs.astro.build/en/guides/internationalization/.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.