update configuration docs, fix some docstrings #1530
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Signed-off-by: Niels Bantilan <niels.bantilan@gmail.com>
cosmicBboy
requested review from
wild-endeavor,
kumare3,
eapolinario and
pingsutw
as code owners
Signed-off-by: Niels Bantilan <niels.bantilan@gmail.com>
Codecov Report
@@ Coverage Diff @@
## master #1530 +/- ##
=======================================
Coverage 69.26% 69.26%
=======================================
Files 315 315
Lines 28844 28854 +10
Branches 2741 2742 +1
=======================================
+ Hits 19978 19987 +9
- Misses 8349 8350 +1
Partials 517 517
Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here. |
wild-endeavor
previously approved these changes
Mar 2, 2023
flytekit/configuration/__init__.py
Outdated
|
|
||
| **YAML Format Configuration File**: A configuration file that contains settings for both | ||
| `flytectl <https://docs.flyte.org/projects/flytectl/>`__ and ``flytekit``. This is the recommended configuration | ||
| file format. Invoke ``flytectl --help`` to learn about all of the configuration yaml options. |
There was a problem hiding this comment.
should we mention that it might be helpful to generate this file from calling the flytectl init config command? and that the image section, even though it's not respected by flytectl, can still be understood by flytekit? or will this be confusing? it feels a bit confusing.
Signed-off-by: Niels Bantilan <niels.bantilan@gmail.com>
wild-endeavor
approved these changes
Mar 2, 2023
2 tasks
wild-endeavor
pushed a commit
that referenced
this pull request
Mar 7, 2023
* update configuration docs, fix some docstrings Signed-off-by: Niels Bantilan <niels.bantilan@gmail.com> * update copy Signed-off-by: Niels Bantilan <niels.bantilan@gmail.com> * add config init command Signed-off-by: Niels Bantilan <niels.bantilan@gmail.com> --------- Signed-off-by: Niels Bantilan <niels.bantilan@gmail.com>
wild-endeavor
pushed a commit
that referenced
this pull request
Mar 7, 2023
* update configuration docs, fix some docstrings Signed-off-by: Niels Bantilan <niels.bantilan@gmail.com> * update copy Signed-off-by: Niels Bantilan <niels.bantilan@gmail.com> * add config init command Signed-off-by: Niels Bantilan <niels.bantilan@gmail.com> --------- Signed-off-by: Niels Bantilan <niels.bantilan@gmail.com>
eapolinario
added a commit
that referenced
this pull request
Mar 8, 2023
* Create non-root user after apt-get (#1519) * Create non-root user after apt-get Signed-off-by: Eduardo Apolinario <eapolinario@users.noreply.github.com> * Create user after pip install Signed-off-by: Kevin Su <pingsutw@apache.org> --------- Signed-off-by: Eduardo Apolinario <eapolinario@users.noreply.github.com> Signed-off-by: Kevin Su <pingsutw@apache.org> Co-authored-by: Eduardo Apolinario <eapolinario@users.noreply.github.com> Co-authored-by: Kevin Su <pingsutw@apache.org> * Add root pyflyte reference to docs (#1520) Signed-off-by: Eduardo Apolinario <eapolinario@users.noreply.github.com> Co-authored-by: Eduardo Apolinario <eapolinario@users.noreply.github.com> * DuckDB plugin (#1419) * DuckDB integration Signed-off-by: Samhita Alla <aallasamhita@gmail.com> * add sd test and fix import Signed-off-by: Samhita Alla <samhitaalla@Samhitas-MacBook-Pro.local> Signed-off-by: Samhita Alla <aallasamhita@gmail.com> * fix lint error Signed-off-by: Samhita Alla <aallasamhita@gmail.com> * fix lint error Signed-off-by: Samhita Alla <aallasamhita@gmail.com> * list to List Signed-off-by: Samhita Alla <aallasamhita@gmail.com> * lint Signed-off-by: Samhita Alla <aallasamhita@gmail.com> * incorporated suggestions Signed-off-by: Samhita Alla <aallasamhita@gmail.com> * add duckdb to requirements and add gh action to detect doc warnings and errors Signed-off-by: Samhita Alla <aallasamhita@gmail.com> * gh action: python 3.9 Signed-off-by: Samhita Alla <aallasamhita@gmail.com> * docs python 3.8 to 3.9 Signed-off-by: Samhita Alla <aallasamhita@gmail.com> --------- Signed-off-by: Samhita Alla <aallasamhita@gmail.com> Signed-off-by: Samhita Alla <samhitaalla@Samhitas-MacBook-Pro.local> Co-authored-by: Kevin Su <pingsutw@apache.org> * add string as a valid input (#1527) * add string as a valid input Signed-off-by: Samhita Alla <aallasamhita@gmail.com> * isort Signed-off-by: Samhita Alla <aallasamhita@gmail.com> * tests Signed-off-by: Samhita Alla <aallasamhita@gmail.com> * Lint Signed-off-by: Eduardo Apolinario <eapolinario@users.noreply.github.com> --------- Signed-off-by: Samhita Alla <aallasamhita@gmail.com> Signed-off-by: Eduardo Apolinario <eapolinario@users.noreply.github.com> Co-authored-by: Eduardo Apolinario <eapolinario@users.noreply.github.com> * Add back attempt to use existing serialization settings when running (#1529) Signed-off-by: Yee Hing Tong <wild-endeavor@users.noreply.github.com> * update configuration docs, fix some docstrings (#1530) * update configuration docs, fix some docstrings Signed-off-by: Niels Bantilan <niels.bantilan@gmail.com> * update copy Signed-off-by: Niels Bantilan <niels.bantilan@gmail.com> * add config init command Signed-off-by: Niels Bantilan <niels.bantilan@gmail.com> --------- Signed-off-by: Niels Bantilan <niels.bantilan@gmail.com> * Revert "Make flytekit comply with PEP-561 (#1516)" (#1532) This reverts commit b3ad158. Signed-off-by: Eduardo Apolinario <eapolinario@users.noreply.github.com> Co-authored-by: Eduardo Apolinario <eapolinario@users.noreply.github.com> Signed-off-by: Yee Hing Tong <wild-endeavor@users.noreply.github.com> * Failed to initialize FlyteInvalidInputException (#1534) Signed-off-by: Kevin Su <pingsutw@apache.org> * cherry pick pin fsspec commit Signed-off-by: Yee Hing Tong <wild-endeavor@users.noreply.github.com> * Set flytekit<1.3.0 in duckdb tests Signed-off-by: eduardo apolinario <eapolinario@users.noreply.github.com> * Fix flyteidl==1.2.9 in doc-requirements.txt Signed-off-by: eduardo apolinario <eapolinario@users.noreply.github.com> * No duckdb documentation Signed-off-by: eduardo apolinario <eapolinario@users.noreply.github.com> * Linting Signed-off-by: eduardo apolinario <eapolinario@users.noreply.github.com> --------- Signed-off-by: Eduardo Apolinario <eapolinario@users.noreply.github.com> Signed-off-by: Kevin Su <pingsutw@apache.org> Signed-off-by: Samhita Alla <aallasamhita@gmail.com> Signed-off-by: Samhita Alla <samhitaalla@Samhitas-MacBook-Pro.local> Signed-off-by: Yee Hing Tong <wild-endeavor@users.noreply.github.com> Signed-off-by: Niels Bantilan <niels.bantilan@gmail.com> Signed-off-by: eduardo apolinario <eapolinario@users.noreply.github.com> Co-authored-by: Eduardo Apolinario <653394+eapolinario@users.noreply.github.com> Co-authored-by: Eduardo Apolinario <eapolinario@users.noreply.github.com> Co-authored-by: Kevin Su <pingsutw@apache.org> Co-authored-by: Samhita Alla <aallasamhita@gmail.com> Co-authored-by: Niels Bantilan <niels.bantilan@gmail.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
TL;DR
Add more detail to the configuration docs, specifically calling out how the
config.yamlfile can be used for both flytectl and flytekit.Type
Are all requirements met?
Tracking Issue
https://github.com/flyteorg/flyte/issues/
Follow-up issue
NA