Some important docs updates #2463

htahir1 · 2024-02-22T16:23:51Z

Describe changes

I fixed a few things and made zenml cloud more visible, as we offer a free account now.

Pre-requisites

Please ensure you have done the following:

I have read the CONTRIBUTING.md document.
If my change requires a change to docs, I have updated the documentation accordingly.
I have added tests to cover my changes.
I have based my new branch on develop and the open PR is targeting develop. If your branch wasn't based on develop read Contribution guide on rebasing branch to develop.
If my changes require changes to the dashboard, these changes are communicated/requested.

Types of changes

Bug fix (non-breaking change which fixes an issue)
New feature (non-breaking change which adds functionality)
Breaking change (fix or feature that would cause existing functionality to change)
Other (add details above)

coderabbitai · 2024-02-22T16:24:01Z

Important

Auto Review Skipped

Auto reviews are disabled on this repository.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository.

To trigger a single review, invoke the @coderabbitai review command.

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?

Share

Tips

Chat

There are 3 ways to chat with CodeRabbit:

Review comments: Directly reply to a review comment made by CodeRabbit. Example:
- I pushed a fix in commit <commit_id>.
- Generate unit-tests for this file.
Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
- @coderabbitai generate unit tests for this file.
- @coderabbitai modularize this function.
PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
- @coderabbitai generate interesting stats about this repository from git and render them as a table.
- @coderabbitai show all the console.log statements in this repository.
- @coderabbitai read src/utils.ts and generate unit tests.
- @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

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 as PR comments)

@coderabbitai pause to pause the reviews on a PR.
@coderabbitai resume to resume the paused reviews.
@coderabbitai review to trigger a review. This is useful when automatic reviews are disabled for the repository.
@coderabbitai resolve resolve all the CodeRabbit review comments.
@coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration File (`.coderabbit.yaml`)

You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
The JSON schema for the configuration file is available here.
If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/coderabbit-overrides.v2.json

CodeRabbit Discord Community

Join our Discord Community to get help, request features, and share feedback.

github-actions · 2024-02-22T16:26:07Z

Images automagically compressed by Calibre's image-actions ✨

Compression reduced images by 7%, saving 68.43 KB.

Filename	Before	After	Improvement	Visual comparison
`docs/book/.gitbook/assets/zenml-cloud-tenant-overview.png`	270.12 KB	242.83 KB	-10.1%	View diff
`docs/book/.gitbook/assets/zenml-hero.png`	139.14 KB	121.37 KB	-12.8%	View diff
`docs/book/.gitbook/assets/zenml-why.png`	563.77 KB	540.40 KB	-4.1%	View diff

231 images did not require optimisation.

Update required: Update image-actions configuration to the latest version before 1/1/21. See README for instructions.

README.md

docs/book/deploying-zenml/zenml-cloud/cloud-system-architecture.md

docs/book/deploying-zenml/zenml-cloud/zenml-cloud.md

docs/book/getting-started/installation.md

… doc/some-imp-updates

Co-authored-by: Alex Strick van Linschoten <strickvl@users.noreply.github.com>

…e.md Co-authored-by: Alex Strick van Linschoten <strickvl@users.noreply.github.com>

Co-authored-by: Alex Strick van Linschoten <strickvl@users.noreply.github.com>

strickvl

Better now. just a few remaining nits / questions.

strickvl · 2024-02-23T10:21:54Z

README.md

 </div>

+ZenML aims to optimize your entire machine learning lifecycle - you'll be 80% faster to production, generate 3x more models, and massively reduce your cloud spend.


maybe instead of "aims to", something more active?

ZenML optimizes your entire...

ZenML is all about optimizing your...

etc

also feels like maybe these very precise numbers need links to user case studies etc. without links it feels a bit arbitrary? (Not sure how others would read it, though).

README.md

Co-authored-by: Alex Strick van Linschoten <strickvl@users.noreply.github.com>

… doc/some-imp-updates

bcdurak · 2024-02-23T11:39:49Z

docs/book/.gitbook/assets/zenml-why.png:Zone.Identifier

What is this file?

mistake. thanks for cathcing!

docs/book/deploying-zenml/zenml-cloud/zenml-cloud.md

docs/book/getting-started/installation.md

README.md

bcdurak · 2024-02-23T11:52:36Z

README.md

 </div>

+ZenML optimizes your entire machine learning lifecycle - you'll be 80% faster to production, generate 3x more models, and massively reduce your cloud spend.


I think these numbers can be very situational and it feels a bit off displaying them without any resources to back it up.

README.md

Co-authored-by: Barış Can Durak <36421093+bcdurak@users.noreply.github.com>

… doc/some-imp-updates

* Add mention of deploying zenml in installation * Add mention of deploying zenml in installation * Add mention of deploying zenml in installation * ZenML Cloud * More ZenML Cloud * Added assets * README * READ * latest * latest * README * README * README * README * README * README * README * Optimised images with calibre/image-actions * README * Update README.md Co-authored-by: Alex Strick van Linschoten <strickvl@users.noreply.github.com> * Update docs/book/deploying-zenml/zenml-cloud/cloud-system-architecture.md Co-authored-by: Alex Strick van Linschoten <strickvl@users.noreply.github.com> * Update docs/book/deploying-zenml/zenml-cloud/zenml-cloud.md Co-authored-by: Alex Strick van Linschoten <strickvl@users.noreply.github.com> * Update docs/book/getting-started/installation.md Co-authored-by: Alex Strick van Linschoten <strickvl@users.noreply.github.com> * Update docs/book/deploying-zenml/zenml-cloud/zenml-cloud.md Co-authored-by: Alex Strick van Linschoten <strickvl@users.noreply.github.com> * Update docs/book/deploying-zenml/zenml-cloud/zenml-cloud.md Co-authored-by: Alex Strick van Linschoten <strickvl@users.noreply.github.com> * Update README.md Co-authored-by: Alex Strick van Linschoten <strickvl@users.noreply.github.com> * Update README.md Co-authored-by: Alex Strick van Linschoten <strickvl@users.noreply.github.com> * Update README.md Co-authored-by: Alex Strick van Linschoten <strickvl@users.noreply.github.com> * Update README.md Co-authored-by: Alex Strick van Linschoten <strickvl@users.noreply.github.com> * Update README.md Co-authored-by: Alex Strick van Linschoten <strickvl@users.noreply.github.com> * Update README.md Co-authored-by: Alex Strick van Linschoten <strickvl@users.noreply.github.com> * Update README.md Co-authored-by: Alex Strick van Linschoten <strickvl@users.noreply.github.com> * latest * README again * More WHy * Latest * Latest * Latest * ZenmL Cloud * Update README.md Co-authored-by: Alex Strick van Linschoten <strickvl@users.noreply.github.com> * README again * Apply suggestions from code review Co-authored-by: Barış Can Durak <36421093+bcdurak@users.noreply.github.com> * latest * Update docs/book/getting-started/installation.md Co-authored-by: Barış Can Durak <36421093+bcdurak@users.noreply.github.com> * latest --------- Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com> Co-authored-by: Alex Strick van Linschoten <strickvl@users.noreply.github.com> Co-authored-by: Barış Can Durak <36421093+bcdurak@users.noreply.github.com> (cherry picked from commit 909ea63)

htahir1 · 2024-02-23T12:15:48Z

@strickvl @bcdurak thanks for the reviews. i merged and backported

* Add mention of deploying zenml in installation * Add mention of deploying zenml in installation * Add mention of deploying zenml in installation * ZenML Cloud * More ZenML Cloud * Added assets * README * READ * latest * latest * README * README * README * README * README * README * README * Optimised images with calibre/image-actions * README * Update README.md Co-authored-by: Alex Strick van Linschoten <strickvl@users.noreply.github.com> * Update docs/book/deploying-zenml/zenml-cloud/cloud-system-architecture.md Co-authored-by: Alex Strick van Linschoten <strickvl@users.noreply.github.com> * Update docs/book/deploying-zenml/zenml-cloud/zenml-cloud.md Co-authored-by: Alex Strick van Linschoten <strickvl@users.noreply.github.com> * Update docs/book/getting-started/installation.md Co-authored-by: Alex Strick van Linschoten <strickvl@users.noreply.github.com> * Update docs/book/deploying-zenml/zenml-cloud/zenml-cloud.md Co-authored-by: Alex Strick van Linschoten <strickvl@users.noreply.github.com> * Update docs/book/deploying-zenml/zenml-cloud/zenml-cloud.md Co-authored-by: Alex Strick van Linschoten <strickvl@users.noreply.github.com> * Update README.md Co-authored-by: Alex Strick van Linschoten <strickvl@users.noreply.github.com> * Update README.md Co-authored-by: Alex Strick van Linschoten <strickvl@users.noreply.github.com> * Update README.md Co-authored-by: Alex Strick van Linschoten <strickvl@users.noreply.github.com> * Update README.md Co-authored-by: Alex Strick van Linschoten <strickvl@users.noreply.github.com> * Update README.md Co-authored-by: Alex Strick van Linschoten <strickvl@users.noreply.github.com> * Update README.md Co-authored-by: Alex Strick van Linschoten <strickvl@users.noreply.github.com> * Update README.md Co-authored-by: Alex Strick van Linschoten <strickvl@users.noreply.github.com> * latest * README again * More WHy * Latest * Latest * Latest * ZenmL Cloud * Update README.md Co-authored-by: Alex Strick van Linschoten <strickvl@users.noreply.github.com> * README again * Apply suggestions from code review Co-authored-by: Barış Can Durak <36421093+bcdurak@users.noreply.github.com> * latest * Update docs/book/getting-started/installation.md Co-authored-by: Barış Can Durak <36421093+bcdurak@users.noreply.github.com> * latest --------- Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com> Co-authored-by: Alex Strick van Linschoten <strickvl@users.noreply.github.com> Co-authored-by: Barış Can Durak <36421093+bcdurak@users.noreply.github.com>

htahir1 added 17 commits February 22, 2024 15:28

Add mention of deploying zenml in installation

0c21fef

Add mention of deploying zenml in installation

05b50a0

Add mention of deploying zenml in installation

285e4d4

ZenML Cloud

83f448b

More ZenML Cloud

7614908

Added assets

82d16ba

README

043d823

READ

c64eb8c

latest

fb9f311

latest

3d2e333

README

01b200e

README

62f10c0

README

ff24e8d

README

84216a5

README

e9c5a95

README

0b69f5e

README

2111e60

htahir1 requested a review from strickvl February 22, 2024 16:23

github-actions bot added the internal To filter out internal PRs and issues label Feb 22, 2024

htahir1 requested a review from bcdurak February 22, 2024 16:24

Optimised images with calibre/image-actions

ae3e6df

strickvl reviewed Feb 22, 2024

View reviewed changes

htahir1 and others added 6 commits February 22, 2024 17:53

README

e21cded

Merge branch 'doc/some-imp-updates' of github.com:zenml-io/zenml into…

f6d1d20

… doc/some-imp-updates

Update README.md

91d7f44

Co-authored-by: Alex Strick van Linschoten <strickvl@users.noreply.github.com>

Update docs/book/deploying-zenml/zenml-cloud/cloud-system-architectur…

a2decb9

…e.md Co-authored-by: Alex Strick van Linschoten <strickvl@users.noreply.github.com>

Update docs/book/deploying-zenml/zenml-cloud/zenml-cloud.md

b8f25a0

Co-authored-by: Alex Strick van Linschoten <strickvl@users.noreply.github.com>

Update docs/book/getting-started/installation.md

489a68c

Co-authored-by: Alex Strick van Linschoten <strickvl@users.noreply.github.com>

htahir1 and others added 3 commits February 23, 2024 10:00

Update README.md

c6f52fa

Co-authored-by: Alex Strick van Linschoten <strickvl@users.noreply.github.com>

Update README.md

1af467d

Co-authored-by: Alex Strick van Linschoten <strickvl@users.noreply.github.com>

Update README.md

99caf74

Co-authored-by: Alex Strick van Linschoten <strickvl@users.noreply.github.com>

strickvl approved these changes Feb 23, 2024

View reviewed changes

strickvl changed the title ~~Some imp docs updates~~ Some important docs updates Feb 23, 2024

htahir1 added 7 commits February 23, 2024 10:30

latest

869b2ae

README again

d7fd32e

More WHy

4ab7ab3

Latest

d64cdc1

Latest

90613b4

Latest

c7fd707

ZenmL Cloud

4d56ae1

strickvl self-requested a review February 23, 2024 10:20

strickvl requested changes Feb 23, 2024

View reviewed changes

htahir1 and others added 3 commits February 23, 2024 11:26

Update README.md

481918e

Co-authored-by: Alex Strick van Linschoten <strickvl@users.noreply.github.com>

README again

b0491dd

Merge branch 'doc/some-imp-updates' of github.com:zenml-io/zenml into…

8eb35a1

… doc/some-imp-updates

htahir1 requested a review from strickvl February 23, 2024 10:36

strickvl approved these changes Feb 23, 2024

View reviewed changes

bcdurak requested changes Feb 23, 2024

View reviewed changes

htahir1 and others added 5 commits February 23, 2024 13:11

Apply suggestions from code review

973942d

Co-authored-by: Barış Can Durak <36421093+bcdurak@users.noreply.github.com>

latest

6fa2bc3

Update docs/book/getting-started/installation.md

6cef4b0

Co-authored-by: Barış Can Durak <36421093+bcdurak@users.noreply.github.com>

Merge branch 'doc/some-imp-updates' of github.com:zenml-io/zenml into…

4d91af4

… doc/some-imp-updates

latest

20cd28a

htahir1 merged commit 909ea63 into develop Feb 23, 2024
7 checks passed

htahir1 deleted the doc/some-imp-updates branch February 23, 2024 12:13

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Some important docs updates #2463

Some important docs updates #2463

htahir1 commented Feb 22, 2024

coderabbitai bot commented Feb 22, 2024

Auto Review Skipped

Chat

CodeRabbit Commands (invoked as PR comments)

CodeRabbit Configration File (`.coderabbit.yaml`)

CodeRabbit Discord Community

github-actions bot commented Feb 22, 2024

strickvl left a comment

strickvl Feb 23, 2024

strickvl Feb 23, 2024

bcdurak Feb 23, 2024

htahir1 Feb 23, 2024

bcdurak Feb 23, 2024

htahir1 commented Feb 23, 2024

		</div>

		ZenML aims to optimize your entire machine learning lifecycle - you'll be 80% faster to production, generate 3x more models, and massively reduce your cloud spend.

		</div>

		ZenML optimizes your entire machine learning lifecycle - you'll be 80% faster to production, generate 3x more models, and massively reduce your cloud spend.

Some important docs updates #2463

Some important docs updates #2463

Conversation

htahir1 commented Feb 22, 2024

Describe changes

Pre-requisites

Types of changes

coderabbitai bot commented Feb 22, 2024

Auto Review Skipped

Chat

CodeRabbit Commands (invoked as PR comments)

CodeRabbit Configration File (.coderabbit.yaml)

CodeRabbit Discord Community

github-actions bot commented Feb 22, 2024

strickvl left a comment

Choose a reason for hiding this comment

strickvl Feb 23, 2024

Choose a reason for hiding this comment

strickvl Feb 23, 2024

Choose a reason for hiding this comment

bcdurak Feb 23, 2024

Choose a reason for hiding this comment

htahir1 Feb 23, 2024

Choose a reason for hiding this comment

bcdurak Feb 23, 2024

Choose a reason for hiding this comment

htahir1 commented Feb 23, 2024

CodeRabbit Configration File (`.coderabbit.yaml`)