openEOPlatform / documentation

Documentation for openEO Platform
https://docs.openeo.cloud
Apache License 2.0
1 stars 5 forks source link

update naming convening #59

Closed dthiex closed 1 year ago

dthiex commented 1 year ago

Closes https://github.com/openEOPlatform/architecture-docs/issues/302

This PR improves the naming convention. I tried to take all comments from the issue into consideration. New suggestions welcome!

dthiex commented 1 year ago

Should we mention somewhere to use uppercase characters only? It could be easily understood from the examples, but better mentioning it.

This is mentioned already in line 16 - Names should be written in capital letters ("all caps")

clausmichele commented 1 year ago

Should we mention somewhere to use uppercase characters only? It could be easily understood from the examples, but better mentioning it.

This is mentioned already in line 16 - Names should be written in capital letters ("all caps")

Sorry I totally missed it

m-mohr commented 1 year ago

Looks good. I'd like to see the existing collections being mapped to the new schema to see whether it works well for what we have already.

dthiex commented 1 year ago

Looks good. I'd like to see the existing collections being mapped to the new schema to see whether it works well for what we have already.

I did this for the first 30 collections at our collections endpoint and slights improve the rules/recommendations. Overall most are compliant to the schema (24, 5 are partially, 1 is not).

The main "problem" are 6/114 collections that don't follow the Names should be written in capital letters rule but otherwise it works quite well.

Will merge this now and we can improve it further when necessary.