okteto / docs

Apache License 2.0
6 stars 18 forks source link

Document manifest property `dependencies.<item>.namespace` #420

Open andreafalzetti opened 1 year ago

andreafalzetti commented 1 year ago

As per the title!

See: https://github.com/okteto/okteto/blob/master/pkg/model/manifest.go#L1002

aroramrinaal commented 1 year ago

hey @andreafalzetti , I would like to work on this good-first-issue.

andreafalzetti commented 1 year ago

Thanks for the interest @aroramrinaal - feel free to start on this. If you need support, don't hesitate to reach out :)

ArslanYM commented 1 year ago

Is this issue still open?

andreafalzetti commented 1 year ago

@ArslanYM yes, it is

ArslanYM commented 1 year ago

Can I work on this?

andreafalzetti commented 1 year ago

@ArslanYM thanks for offering your help, the docs repo is this one: https://github.com/okteto/docs

if you need any context or help, let me know

thanks!

ArslanYM commented 1 year ago

Can you give some context about the issue and how to approach this?

andreafalzetti commented 1 year ago

Can you give some context about the issue and how to approach this?

This is a docs issue, so it would require understanding what property we're documenting here. The namespace of a dependency allows deploying a dependency in a different namespace. It's not the most common scenario but it's a use case that exists. At the moment namespace is not mentioned in docs: https://www.okteto.com/docs/reference/manifest/#dependencies-string-optional

As part of this ticket we can add it to the docs

UtkarshUmre commented 10 months ago

Is this issue still open?

seanson commented 3 weeks ago

Definitely still an issue as the Manifest documentation still gives the type as an optional list of strings and there are quite a few properties available but only documented above as an "extended notation".

https://github.com/okteto/okteto/blob/18ce425b3e1a51da6a345c38dc391ac1fd21fd16/pkg/deps/deps.go#L31

seanson commented 3 weeks ago

Apologies, as a followup: It looks like Namespace itself is going to be removed in the upcoming 3.x branch, but still exists in the 2.31.0 release. I think it would still be worth documenting as part of the whole resource though.