editor-layer-index icon indicating copy to clipboard operation
editor-layer-index copied to clipboard

Document the data model and testing workflow

Open tordans opened this issue 7 years ago • 3 comments

To make it easier to contribute …

a. it would be great to have a documentation of the data model for the json.

Eg the "required:true" attribute is interesting, what does it "do" / how are clients supposed to use/interpret it?

b. it would be great to have a documentation about how to test a PR.

Eg is the only way to test this to create a local iD Editor instance and run it against a local copy? How would I do this? Or is there maybe a version of iD Editor that allows testing of manually pasted JSON files?

Thanks

Update:

  • "best" is described at https://github.com/osmlab/editor-layer-index/issues/130#issuecomment-229060048

    Consider "best" as meaning "better than Bing according to local mappers".

  • "required" is described at https://github.com/osmlab/editor-layer-index/pull/515#issuecomment-401126175 ""

    an editor is required to show the attribution line

tordans avatar Aug 16 '18 19:08 tordans

a. it would be great to have a documentation of the data model for the json.

The JSON-Schema doc https://github.com/osmlab/editor-layer-index/blob/gh-pages/schema.json is both the data model and the documentation.

bhousel avatar Aug 26 '18 04:08 bhousel

For Reference: https://github.com/osmlab/editor-layer-index/issues/562

tordans avatar Oct 01 '18 06:10 tordans

Related #2625

danieldegroot2 avatar Jul 04 '25 14:07 danieldegroot2