Parent URI points to an invalid devfile

[kim-tsao]

/area documentation

Which area this documentation change is related to?

/area api

Issue details

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

The parent URI example that's given in our docs points to a v1.0 devfile. This will cause a validation error because the mandatory schemaVersion is missing. Please update the docs to include this URI instead https://raw.githubusercontent.com/odo-devfiles/registry/master/devfiles/nodejs/devfile.yaml

[johnmcollier]

Please update the docs to include this URI instead https://raw.githubusercontent.com/odo-devfiles/registry/master/devfiles/nodejs/devfile.yaml

Slight nitpick, we shouldn't link to that repo any more since it's deprecated, the devfile from devfile/registry should be used instead: https://raw.githubusercontent.com/devfile/registry/main/stacks/nodejs/devfile.yaml

[jc-berger]

Thanks, Kim for locating this concern :)

Where in our docs to we link to https://raw.githubusercontent.com/eclipse/che-devfile-registry/master/devfiles/nodejs/devfile.yaml ?

I am going through our docs now and am not seeing where we link to this sample yaml.

[kim-tsao]

Hi Jake, it's in our parent devfile topic: https://docs.devfile.io/devfile/2.0.0/user-guide/refering-to-a-parent-devfile-in-a-devfile.html, example 2

[jc-berger]

Thanks, Kim, for the clarification!

Please see the new PR 82: devfile/docs#82, that I just made for this issue. If it's only a simple URI change, we should be good to go ahead and merge, thanks!

[kim-tsao]

Thanks, Kim, for the clarification!

Please see the new PR, #82, that I just made for this issue. If it's only a simple URI change, we should be good to go ahead and merge, thanks!

Thanks @jc-berger , is the PR link incorrect?

[jc-berger]

@kim-tsao lol, not it's not. It linked to PR 82 in API, not the Doc repo.

Use this link for the doc PR that fixes the URI, thanks!

devfile/docs#82

[kim-tsao]

@jc-berger the URL update looks good but I should have noticed this other error before. Can you please remove id from this example? The spec says you can only specify oneof id, uri, or kubernetes

[jc-berger]

@kim-tsao , nice catch and sure thing. I think you're looking at 2.1 and not 2.2 Alpha. I don't see id in the example in our referring to parent doc. See the screenshots of the published doc and my PR.

Basically, I think the id has already been removed, phew!

[kim-tsao]

@jc-berger you're right, I was looking at an older spec (v2.0.0). Is it possible to update that version?

[jc-berger]

@kim-tsao, honestly, I don't know. I simply always specify that I'm on the latest version when I look at docs. I'll often make the mistake of looking at the outdated version.

We can ask at our team call tomorrow!