devfile / api

Kube-native API for cloud development workspaces specification
Apache License 2.0
257 stars 61 forks source link

[Spike] Review documentation for event bindings on devfile.io and devfile schema #1578

Open thepetk opened 3 months ago

thepetk commented 3 months ago

/area documentation

Which area is this documentation change related to?

/area library

Issue details

It would be nice to review once more the event bindings page (https://devfile.io/docs/2.2.2/adding-event-bindings) on devfile.io. We could make more explicit any validation rules that the preStart & postStart fields have etc.

Other than the documentation at devfile.io we could also review the related fields on the devfile schema as they're might be implementation specific.

What mistake did you find / what is missing in the documentation?

N/A just a suggestion for improvement.

Acceptance Criteria

Jdubrick commented 2 months ago

If there is a change to documentation we need to ensure we test it out to make sure everything is okay