Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add dependencies to manifest documentation. Add namespace to last versioned docs. #857

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

seanson
Copy link

@seanson seanson commented Sep 29, 2024

Resolves #420
This adds documentation to the extended notation for dependencies in the Okteto manifest.

The contributing docs mentions that only current documentation should be modified but I am not sure how that works with documentation changes that are both present in previous versions and about to change with the 3.x release, so I have added an extra change to the 1.24 version documentation.

If this is not ideal then I'm glad to amend the commit.

@@ -96,6 +96,8 @@ Follow this document for a list of [environment variables](reference/okteto-cli.

Use `okteto deploy --dependencies` to force the redeployment of your dependencies.

### dependencies - extended notation (object, optional)
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Let's remove this line. That way everything is index under dependencies

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is there a good way we can communicate that this property has a simple and an extended notation then? I like the idea of the formatting being consistent but need a way as a consumer to know that there are two explicit versions. (Sidenote, is there a YAML schema for the Okteto file somewhere?)

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We don't have a YAML schema for the Okteto Manifest yet 😥
Are you familiar with any documentation where they document different field types?
I have been looking for inspiration, but didn't find anything great

@@ -111,22 +113,45 @@ dependencies:
timeout: 15m
```

Or:
#### repository (string)
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I would use the same format that we use in the build section. We put the sample first, and then a list of items explaining each field

@pchico83
Copy link
Contributor

Thanks @seanson for taking care of this! I suggested using the same format as similar sections, but I am happy to consider a different formatting if you find it more practical

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Document manifest property dependencies.<item>.namespace
2 participants