-
Notifications
You must be signed in to change notification settings - Fork 467
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 on ZenML setup #3100
Docs on ZenML setup #3100
Conversation
@htahir1 updated with all my fixes. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Some minor comments on latest changes
docs/book/how-to/setting-up-a-project-repository/shared-components-for-teams.md
Outdated
Show resolved
Hide resolved
|
||
## So how do I put this all together? | ||
|
||
![Diagram showing how Models bring together Pipelines and Artifacts](../../.gitbook/assets/model_pipeline_artifact.png) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@strickvl are you working on this one?
docs/book/how-to/setting-up-a-project-repository/stacks-pipelines-models.md
Outdated
Show resolved
Hide resolved
Important Review skippedAuto reviews are disabled on this repository. Please check the settings in the CodeRabbit UI or the You can disable this status message by setting the Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media? 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
Documentation and Community
|
Images automagically compressed by Calibre's image-actions ✨ Compression reduced images by 13.9%, saving 14.92 KB.
365 images did not require optimisation. Update required: Update image-actions configuration to the latest version before 1/1/21. See README for instructions. |
Learn more about the best practices in managing credentials and recommended roles in our [Managing Stacks and Components guide](../stack-deployment/README.md). | ||
|
||
|
||
## ZenML Server Upgrades |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Maybe you should then title it "Who is responsible for upgrading the ZenML server?"
and more. Read in detail about the best practices for upgrading your ZenML server in the [Best Practices for Upgrading ZenML Servers](../manage-the-zenml-server/best-practices-upgrading-zenml.md) guide. | ||
|
||
|
||
## Pipeline Migration and Maintenance |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Maybe "Who is responsible for migrating and maintaining pipelines?"
docs/book/how-to/setting-up-a-project-repository/shared-components-for-teams.md
Outdated
Show resolved
Hide resolved
docs/book/how-to/setting-up-a-project-repository/stacks-pipelines-models.md
Outdated
Show resolved
Hide resolved
|
||
## So how do I put this all together? | ||
|
||
![Diagram showing how Models bring together Pipelines and Artifacts](../../.gitbook/assets/model_pipeline_artifact.png) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Images automagically compressed by Calibre's image-actions ✨ Compression reduced images by 29.4%, saving 64.14 KB.
366 images did not require optimisation. Update required: Update image-actions configuration to the latest version before 1/1/21. See README for instructions. |
Images automagically compressed by Calibre's image-actions ✨ Compression reduced images by 43.1%, saving 711.53 KB.
365 images did not require optimisation. Update required: Update image-actions configuration to the latest version before 1/1/21. See README for instructions. |
* add some info on docker skip build * add docs on not building a docker image * update toc and title * added text to stress that this doesnt always happen * Apply suggestions from code review Co-authored-by: Hamza Tahir <hamza@zenml.io> * restructure headings * more english * Apply suggestions from code review Co-authored-by: Alex Strick van Linschoten <strickvl@users.noreply.github.com> * apply review changes * add how to reuse builds page * aoply hamza comments * add redirect for new page name * apply review changes * move the artifact store block to the top * update redirect * add shared components section * scarf * update toc * add stacks, pipelines, and models page * add overview page * add access management guide * update setup repository * update text * Update docs/book/how-to/setting-up-a-project-repository/stacks-pipelines-models.md Co-authored-by: Hamza Tahir <hamza@zenml.io> * update * a tags become markdown links * add artifacts and real life example * fix typos * add scarf * update toc * remove first md * split pypi section out * restructure * add scarf * add diagram * Optimised images with calibre/image-actions * fix spelling * add descriptions * rename some sections * minor changes * Update docs/book/how-to/setting-up-a-project-repository/README.md Co-authored-by: Hamza Tahir <hamza@zenml.io> * Update docs/book/how-to/setting-up-a-project-repository/README.md Co-authored-by: Hamza Tahir <hamza@zenml.io> * Apply suggestions from code review Co-authored-by: Hamza Tahir <hamza@zenml.io> * add info about roles zenml pro * add link * address review feedback * extra spaces * fix naming * add links and update pypi registry example * add example of connector roles * Optimised images with calibre/image-actions * small fix * update section name * apply reviews * update second location for pypi docs * Optimised images with calibre/image-actions * replace image * Optimised images with calibre/image-actions --------- Co-authored-by: Jayesh Sharma <wjayesh@outlook.com> Co-authored-by: Hamza Tahir <hamza@zenml.io> Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com> (cherry picked from commit 128b32f)
Describe changes
I implemented/fixed _ to achieve _.
Pre-requisites
Please ensure you have done the following:
develop
and the open PR is targetingdevelop
. If your branch wasn't based on develop read Contribution guide on rebasing branch to develop.Types of changes