feat: improve registration patterns docs #5808
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
|
Thank you for opening this pull request! 🙌 These tips will help get your PR across the finish line:
|
| If you encounter a ``ModuleNotFoundError`` when packaging, ensure to include the correct source paths by using the `--source` option. For instance: | ||
|
|
||
| ```{prompt} bash $ | ||
| pyflyte --pkgs <dir1> package --source ./src -f |
There was a problem hiding this comment.
@wild-endeavor
I know the "old" flags still work but wanted to double-check that this command would still be valid even if we deprecate the old flags? (re flyteorg/flytekit#2690)
|
Hi @siiddhantt the file you're updating has been moved to /docs/user_guide/flyte_fundamentals/registering_workflows.md -- could you merge master into your branch and apply your changes to the doc in the new location? Thanks! |
|
hi @neverett , merged master into this branch, hope it's good now. Thanks! |
Signed-off-by: Siddhant Rai <[email protected]>
Signed-off-by: Siddhant Rai <[email protected]>
Signed-off-by: Siddhant Rai <[email protected]> Signed-off-by: Siddhant Rai <[email protected]>
* move flytekit and flytectl docs into API section Signed-off-by: nikki everett <[email protected]> * switch to docsearch module and env variables Signed-off-by: nikki everett <[email protected]> * reorganize content for pydata theme Signed-off-by: nikki everett <[email protected]> * more docs reorganization Signed-off-by: nikki everett <[email protected]> * switch to pydata theme Signed-off-by: nikki everett <[email protected]> * reorganize concepts/glossary and ecosystem docs Signed-off-by: nikki everett <[email protected]> * remove unneeded custom CSS and JS files Signed-off-by: nikki everett <[email protected]> * add redirects Signed-off-by: nikki everett <[email protected]> * add more redirects Signed-off-by: nikki everett <[email protected]> * first pass at updating docs contributing guide Signed-off-by: nikki everett <[email protected]> * remove core use cases Signed-off-by: nikki everett <[email protected]> * more edits to docs contributing guide Signed-off-by: nikki everett <[email protected]> * more edits to the flytesnacks contributing guide Signed-off-by: nikki everett <[email protected]> * add content to API reference index page, use consistent title and format for API reference section titles Signed-off-by: nikki everett <[email protected]> * rename deployment section Signed-off-by: nikki everett <[email protected]> * reorganize sections Signed-off-by: nikki everett <[email protected]> * fix typos Signed-off-by: nikki everett <[email protected]> * add docsearch index name and app id Signed-off-by: nikki everett <[email protected]> * add ref to docs contributing doc and move all docsearch stuff to env vars again Signed-off-by: nikki everett <[email protected]> * docs overhaul: render flyteidl under the /api/ path (flyteorg#5802) * fix flyteidl structure so it renders under /api/ Signed-off-by: Niels Bantilan <[email protected]> * do not check in flyteidl docs Signed-off-by: Niels Bantilan <[email protected]> * update gitignore and unneeded conf Signed-off-by: Niels Bantilan <[email protected]> * add mock DOCSEARCH_API_KEY to docs test ci Signed-off-by: Niels Bantilan <[email protected]> * add css styling (flyteorg#5803) * add css styling Signed-off-by: Niels Bantilan <[email protected]> * update logo height Signed-off-by: Niels Bantilan <[email protected]> --------- Signed-off-by: Niels Bantilan <[email protected]> --------- Signed-off-by: Niels Bantilan <[email protected]> * use same icon as union docs Signed-off-by: nikki everett <[email protected]> * sp error Signed-off-by: Niels Bantilan <[email protected]> --------- Signed-off-by: nikki everett <[email protected]> Signed-off-by: Niels Bantilan <[email protected]> Co-authored-by: Niels Bantilan <[email protected]> Signed-off-by: Siddhant Rai <[email protected]>
…h MessagePack (flyteorg#5763) Signed-off-by: Siddhant Rai <[email protected]>
) Signed-off-by: Siddhant Rai <[email protected]>
siiddhantt
force-pushed
the
feat/improve-registration-patterns-docs
branch
from
755f3a3 to
2347fbe
Compare
Signed-off-by: Siddhant Rai <[email protected]>
neverett
previously approved these changes
Oct 7, 2024
Co-authored-by: Nikki Everett <[email protected]> Signed-off-by: Siddhant Rai <[email protected]>
Signed-off-by: Siddhant Rai <[email protected]>
neverett
approved these changes
Oct 8, 2024
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## master #5808 +/- ##
==========================================
+ Coverage 36.35% 36.69% +0.33%
==========================================
Files 1304 1304
Lines 110147 111538 +1391
==========================================
+ Hits 40042 40924 +882
- Misses 65938 66447 +509
Partials 4167 4167
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. |
|
Congrats on merging your first pull request! 🎉 |
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.
Closes #5669
registering_workflowsdocs with updated and new note for issues and workaroundScreenshots
Check all the applicable boxes