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.

Sign up for GitHub

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
Merged

[Docs] add validation file tpye #5259

Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
ab345f4
docs: improve type validation instructions for `python-magic` package
jasonlai1218 Apr 21, 2024
23a0641
chore: improve error handling and logging throughout codebase
jasonlai1218 Apr 21, 2024
a47ae5d
Merge branch 'master' into ft-validation-file-tpye-doc
jasonlai1218 Apr 21, 2024
9e450a7
docs: update installation instructions and package links in user guide
jasonlai1218 Apr 21, 2024
b4a7605
docs: standardize markdown code blocks for OS names
jasonlai1218 Apr 21, 2024
92389a5
docs: improve code readability and remove outdated instructions
jasonlai1218 Apr 21, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 22 additions & 0 deletions docs/user_guide/data_types_and_io/flytefile.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -68,4 +68,26 @@ You can run the workflow locally as follows:
:lines: 75-95
```

You can enable type validation if you have the [python-magic](https://pypi.org/project/python-magic/) package installed.

```{eval-rst}
.. tabs::

.. group-tab:: Mac OS

.. code-block:: bash

brew install libmagic

.. group-tab:: Linux

.. code-block:: bash

sudo apt-get install libmagic1
```

:::{note}
Currently, type validation is only supported on the `Mac OS` and `Linux` platforms.
:::

[flytesnacks]: https://github.com/flyteorg/flytesnacks/tree/master/examples/data_types_and_io/
Loading