mirror of
https://github.com/FoggedLens/iD.git
synced 2026-02-13 01:02:58 +00:00
2
API.md
2
API.md
@@ -5,7 +5,7 @@ This file documents efforts toward establishing a public API for iD.
|
||||
##### iD Standalone
|
||||
|
||||
iD supports several URL parameters. When constructing a URL to a standalone instance
|
||||
of iD (e.g. `http://openstreetmap.us/iD/release/`), the following parameters are available
|
||||
of iD (e.g. `http://preview.ideditor.com/release/`), the following parameters are available
|
||||
in the hash portion of the URL:
|
||||
|
||||
* `map` - A slash separated `zoom/latitude/longitude`. Example:
|
||||
|
||||
@@ -38,10 +38,11 @@ To request a feature:
|
||||
|
||||
## Verifying Bug Fixes
|
||||
|
||||
To verify a bug fix (or test a new feature), use the [master deployment](http://www.openstreetmap.us/iD/master/)
|
||||
(http://www.openstreetmap.us/iD/master/), which is updated every 10 minutes with the latest code.
|
||||
To verify a bug fix (or test a new feature), use the [master deployment](http://preview.ideditor.com/master/)
|
||||
(http://preview.ideditor.com/master/), which is updated every 10 minutes with the
|
||||
latest code and translation strings.
|
||||
|
||||
The deployments on openstreetmap.org and http://www.openstreetmap.us/iD/release/ are updated only
|
||||
The deployments on openstreetmap.org and http://preview.ideditor.com/release/ are updated only
|
||||
with stable releases. Issues that are marked fixed in the tracker may still be present.
|
||||
|
||||
## Translating
|
||||
@@ -64,8 +65,11 @@ preset fields, and lists of search terms. You do _not_ need to translate the
|
||||
search terms literally -- use a set of synonyms and related terms appropriate
|
||||
to the target language, separated by commas.
|
||||
|
||||
[iD translation project on
|
||||
Transifex](https://www.transifex.com/ideditor/id-editor/)
|
||||
You can check your translations in the [master deployment](http://preview.ideditor.com/master/)
|
||||
(http://preview.ideditor.com/master/), which is updated every 10 minutes with the
|
||||
latest code and translation strings.
|
||||
|
||||
[iD translation project on Transifex](https://www.transifex.com/ideditor/id-editor/)
|
||||
|
||||
To get notifications when translation source files change, click **Watch
|
||||
project** button near the bottom of the project page. You can edit your
|
||||
@@ -107,7 +111,7 @@ Use `npm run build` to build the translations with the local changes.
|
||||
|
||||
Documentation is maintained as a series of [Markdown](http://daringfireball.net/projects/markdown/)
|
||||
documents in [core.yaml](/data/core.yaml). The documentation
|
||||
is in the `help` section (currently starting at line 258). The first line
|
||||
is in the `help` section. The first line
|
||||
of each new section of documentation should be of the form
|
||||
|
||||
```markdown
|
||||
|
||||
@@ -16,11 +16,12 @@
|
||||
|
||||
* Read the project [Code of Conduct](CODE_OF_CONDUCT.md) and remember to be nice to one another.
|
||||
* Read up on [Contributing and the code style of iD](CONTRIBUTING.md).
|
||||
* See [open issues in the issue tracker](https://github.com/openstreetmap/iD/issues?state=open) if you're looking for something to do.
|
||||
* See [open issues in the issue tracker](https://github.com/openstreetmap/iD/issues?state=open)
|
||||
if you're looking for something to do.
|
||||
* [Translate!](https://github.com/openstreetmap/iD/blob/master/CONTRIBUTING.md#translating)
|
||||
* Test a prerelease version of iD:
|
||||
* Stable mirror of `release` branch: http://openstreetmap.us/iD/release
|
||||
* Development mirror of `master` branch: http://openstreetmap.us/iD/master
|
||||
* Stable mirror of `release` branch: http://preview.ideditor.com/release
|
||||
* Development mirror of `master` branch + latest translations: http://preview.ideditor.com/master
|
||||
|
||||
Come on in, the water's lovely. More help? Ping `jfire` or `bhousel` on:
|
||||
* [OpenStreetMap US Slack](https://osmus-slack.herokuapp.com/)
|
||||
|
||||
@@ -3,8 +3,8 @@
|
||||
# This is an example script that shows how to pull the latest version
|
||||
# of iD and replace the version string with a git short hash.
|
||||
#
|
||||
# We use this script to maintain the iD mirror at: http://openstreetmap.us/iD/master
|
||||
# It runs via cron job every 15 minutes.
|
||||
# We use this script to maintain the iD mirror at: http://preview.ideditor.com/master
|
||||
# It runs via cron job every 10 minutes.
|
||||
#
|
||||
# To use this on your own site, you'll want to change the `cp` and `chgrp`
|
||||
# lines at the end to match your web server's documentroot folder and security group.
|
||||
|
||||
Reference in New Issue
Block a user