How will the developers add UUIDs in code? For example when they will have to provide default image styles? I faced this situation when I had to add an image style example in a change notice (see https://drupal.org/node/1820974/revisions/view/2855453/2855505).

If we cannot provide a mechanism to let the core do that (e.g. put a placeholder instead a real UUID and let the system replace it when using that config file) then we MUST document this. Hints:

  • Developers should be warned to NOT copy/paste the UUID from elsewhere. They will be tempted to do that.
  • We should provide developers with instructions on how to obtain a valid/unique UUID when they need it. Maybe provide a list of UUID online generators would help?

The discussion is open.

Comments

andypost’s picture

andypost
he/him
Primary language Russian
commented
Issue tags: +DX (Developer Experience)

suppose better to point some web-service that allows generate uuids

jhodgdon’s picture

jhodgdon
she/her
Primary language English
commented

Good idea!

Maybe we should make a UUID topic and put this information there, and then the functions/classes/interfaces/annotations/etc. that require you to supply a UUID could have @ingroup uuid in them to point to that documentation?

Sree’s picture

Sree commented

Yes, a dedicated UUID section would be quiet helpful.
We would link all the documentation related to it under that dedicated section.

jhodgdon’s picture

jhodgdon
she/her
Primary language English
commented
Issue summary: View changes
Status: Active » Closed (works as designed)

I don't really think this is an issue now. To add a UUID field to an entity, someone would probably copy/paste from Node or some other entity type, and realize all they have to do is define a base entity field of type 'uuid'. Done. So... I don't think we really need to make docs about this?