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

[Docs] add validation file tpye #5259

Merged
merged 6 commits into from
Apr 22, 2024

Conversation

jasonlai1218
Copy link
Contributor

@jasonlai1218 jasonlai1218 commented Apr 21, 2024

Tracking issue

Why are the changes needed?

add descrption for verification file type

What changes were proposed in this pull request?

How was this patch tested?

Setup process

Screenshots

Screenshot 2024-04-21 at 4 19 36 PM Screenshot 2024-04-21 at 4 23 40 PM

Check all the applicable boxes

  • I updated the documentation accordingly.
  • All new and existing tests passed.
  • All commits are signed-off.

Related PRs

flyteorg/flytekit#1893

Docs link

- Add instructions for enabling type validation with `python-magic` package
- Note that type validation is currently only supported on `Mac OS` and `Linux` platforms

Signed-off-by: jason.lai <[email protected]>
- Update the error message for invalid input
- Remove unnecessary console.log statements

Signed-off-by: jason.lai <[email protected]>
- Update the link to `python-magic` package in the user guide
- Add installation instructions for `libmagic` on OSX
- Add installation instructions for `libmagic1` on Debian/Ubuntu

Signed-off-by: jason.lai <[email protected]>
- Update the markdown code blocks to include backticks around the OS names

Signed-off-by: jason.lai <[email protected]>
@dosubot dosubot bot added size:S This PR changes 10-29 lines, ignoring generated files. documentation Improvements or additions to documentation labels Apr 21, 2024
pingsutw
pingsutw previously approved these changes Apr 21, 2024
@dosubot dosubot bot added the lgtm This PR has been approved by a maintainer label Apr 21, 2024
- Update code blocks to use `eval-rst` for better rendering
- Remove outdated installation instructions for `libmagic` on OSX and Debian/Ubuntu

Signed-off-by: jason.lai <[email protected]>
@pingsutw pingsutw merged commit fb52e31 into flyteorg:master Apr 22, 2024
46 checks passed
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 lgtm This PR has been approved by a maintainer size:S This PR changes 10-29 lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants