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

Improve documentation/process of writing component yaml files #192

Open
Tracked by #563
Ruwann opened this issue Jun 7, 2023 · 0 comments
Open
Tracked by #563

Improve documentation/process of writing component yaml files #192

Ruwann opened this issue Jun 7, 2023 · 0 comments
Labels
documentation Improvements or additions to documentation

Comments

@Ruwann
Copy link
Member

Ruwann commented Jun 7, 2023

When writing the fondant_component.yaml file, I ran into issues where sometimes types such as int32 are needed, while in other places just a regular int. It would nice to have better documentation on what is expected in which place.
Also, I'm not sure if there are guidelines on deciding between int16, int32, ...

Some things that could be discussed as part of this:

  • Make it more visible in the documentation or create a separate section for it.
  • It's possible to have VS Code validate and generate help on hover based on a jsonschema (which are already used by fondant under the hood), this still requires setup from the user but makes it easier at least when writing these yaml files: image
  • Expose the validation functionality separately, e.g. via CLI so you can easily validate a component spec yourself
@Ruwann Ruwann converted this from a draft issue Jun 7, 2023
@Ruwann Ruwann changed the title Review component spec types Improve documentation/process of writing component yaml files Jun 7, 2023
@RobbeSneyders RobbeSneyders added the documentation Improvements or additions to documentation label Aug 29, 2023
@RobbeSneyders RobbeSneyders moved this from Planned to Backlog in Fondant development Oct 5, 2023
@RobbeSneyders RobbeSneyders moved this from Backlog to Breakdown in Fondant development Oct 29, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
Status: Breakdown
Development

No branches or pull requests

2 participants