Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add translations to documentation #48

Closed
adi-de-masi opened this issue Nov 12, 2018 · 3 comments
Closed

Add translations to documentation #48

adi-de-masi opened this issue Nov 12, 2018 · 3 comments
Labels
Feature Request Missing functionality and changes
Milestone

Comments

@adi-de-masi
Copy link

Is your feature request related to a problem? Please describe.
Many of the features currently described in enums have unclear or ambiguous names. In the corresponding "docs" markdown file, there are additional explanations which might help clarifying what the meaning of those enums is.
Ambiguous names are confusing, different real estates platforms will sooner or later display the same feature differently, and tracking / resolving the issues will waste a lot of resources because also negotiation will be needed ('who did it wrong?').

Describe the solution you'd like
Instead of describing the keywords outside of the schema, we suggest two options:

  1. Introduce a complex type "feature" to replace the enums in "featureTypes" and "numericValuekeys". That new type should have two additional elements: type (numeric, boolean, could even be more explicit like cubic, are, distance..), and translations (default translations for de, en, fr, it).
  2. Improve the documentation for each enum significantly using the <annotation><documentation> tags, get rid of external documentation.

Additional context
For suggestion 1: Declare the translations as "default" or "fixed" attributes in the schema, so that they do not become part of the payload.

@jaggli
Copy link
Contributor

jaggli commented Nov 14, 2018

This is related to #65

@jaggli
Copy link
Contributor

jaggli commented Nov 15, 2018

We will

  • include the english names and a description in english for all the <characteristics>, <attachements>, <seller>... and others, where it makes sense

@jaggli jaggli added this to the 1.0.0 milestone Nov 16, 2018
@jaggli jaggli added the Feature Request Missing functionality and changes label Nov 28, 2018
@jaggli
Copy link
Contributor

jaggli commented Dec 4, 2018

Documented everything as discussed.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Feature Request Missing functionality and changes
Projects
None yet
Development

No branches or pull requests

2 participants