Update starter and create new production guide #2143

htahir1 · 2023-12-13T07:11:58Z

Describe changes

This PR is a revamp of the doc structure. Primary things effected are:

New starter guide
New production guide. Please note that I was unable to finish the production guide but I left it in a state that could get merged
Introducing a new best practices section in Advanced Guide
This docs will be accompanied with a new starter project. Here is the latest state of that

The gitbook space is available here

Things to do:

Run through GPT4 suggestions for all guides
Connect to a deployed zenml service account stuff needs an advanced guide section
Link MCP and GCP advanced guides to starter guide versions
Fix advanced guide sections about MCP and DCP to be clearer and linked to the guide versions
Add a docs page about tags in the advanced guide
Take a look at the projects section and misc other docs pages that are outdated like FAQs

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.
If I have added an integration, I have updated the integrations table and the corresponding website section.
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.

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)

…update-starter-guide

…efactor-docs' into doc/update-starter-guide

…update-starter-guide

…into doc/update-starter-guide

…-guide

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

github-actions · 2024-01-03T12:26:27Z

Images automagically compressed by Calibre's image-actions ✨

Compression reduced images by 40.4%, saving 13.68 KB.

Filename	Before	After	Improvement	Visual comparison
`docs/site/_assets/favicon.png`	33.88 KB	20.19 KB	-40.4%	View diff

243 images did not require optimisation.

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

…into doc/update-starter-guide

…-guide

docs/book/.gitbook/assets/artifact_visualization_dashboard (4) (1).png

strickvl

Nice work on catching all the remaining broken references :)

This looks good to me following a skim through all the changes. You can maybe ignore the scarf comments and we can fix in a separate PR. I'll also maybe set something up to detect / ensure that we have those within the CI process since it often seems to get forgotten.

strickvl · 2024-01-04T11:03:23Z

docs/book/user-guide/advanced-guide/data-management/data-management.md

+- [Metadata](logging-metadata.md) which is associated with various components of ZenML.
+
+This guide dives deeper into the management of this data.


needs scarf?

strickvl · 2024-01-04T11:03:42Z

docs/book/user-guide/advanced-guide/data-management/artifact-versioning.md

file needs scarf at end?

strickvl · 2024-01-04T11:04:14Z

docs/book/user-guide/advanced-guide/data-management/handle-custom-data-types.md

+    first_pipeline()
+```
+
+</details>


also needs scarf here?

* latest * latest * latest * latest * latest * latest * latest * Concepts * latest * latest * latest * latest * latest * latest * latest * latest * Lean starter * new TOC * latest * latest * latest * latest * latest * latest * latest * latest * latest * latest * GITBOOK-5: No subject * Revert "latest" This reverts commit c898778. * latest * latest * latest * latest * latest * latest * latest * latest * latest * latest * latest * latest * latest * latest * latest * latest * latest * latest * latest * latest * latest * latest * latest * latest * latest * latest * latest * latest * latest * latest * latest * latest * latest * latest * latest * latest * latest * latest * latest * latest * latest * latest * latest * latest * latest * latest * latest * latest * latest * latest * latest * latest * Optimised images with calibre/image-actions * Revereted some errorneous things * Revereted some errorneous things * Latest * Latest * Latest * Latest * Latest * Latest * Latest * Latest * Latest * Apply suggestions from code review Co-authored-by: Alex Strick van Linschoten <strickvl@users.noreply.github.com> * s3 access * Ok updated * Review changes * Review changes * Latest * artifact metadata * artifact metadata * Optimised images with calibre/image-actions * Latest * Update * Update * New logging metadata * New logging metadata * More * latest * more * Metadata added * latest * latest * latest * latest * latest * latest * latest * latest * latest * latest * GitBook: No commit message * latest * latest * latest * Optimised images with calibre/image-actions * latest * latest * latest * latest * latest * latest * latest * latest * latest * latest * latest * latest * latest * Update docs/book/user-guide/starter-guide/track-ml-models.md * Update docs/book/user-guide/starter-guide/track-ml-models.md * Update docs/book/user-guide/starter-guide/track-ml-models.md * Update docs/book/user-guide/production-guide/connect-code-repository.md * Update docs/book/user-guide/production-guide/production-guide.md * Update docs/book/user-guide/production-guide/configure-pipeline.md * Update docs/book/user-guide/production-guide/scale-compute.md * Update docs/book/user-guide/production-guide/cloud-stack.md * Update docs/book/stacks-and-components/component-guide/data-validators/great-expectations.md * Update docs/book/user-guide/starter-guide/fetching-pipelines.md * Update docs/book/user-guide/starter-guide/fetching-pipelines.md * Update docs/book/user-guide/starter-guide/manage-artifacts.md * Update docs/book/user-guide/starter-guide/manage-artifacts.md * latest * latest * latest * latest * latest * Fixed validation * Fixed expectation suite * Fixed artifact vis * deleted redundnat asset * deleted redundnat asset * Fixed broken links * Took some input from baris into account * Small changes * Fixed materialization * Fixed materialization * Fixed materialization * Update docs/book/getting-started/core-concepts.md * Update docs/book/user-guide/production-guide/end-to-end.md * Update docs/book/user-guide/production-guide/end-to-end.md * Update docs/book/user-guide/production-guide/end-to-end.md * Update docs/book/user-guide/production-guide/end-to-end.md * Update docs/book/user-guide/production-guide/end-to-end.md * Update docs/book/getting-started/core-concepts.md * Update docs/book/user-guide/advanced-guide/data-management/model-management.md * Update docs/book/user-guide/starter-guide/create-an-ml-pipeline.md * Update docs/book/user-guide/production-guide/production-guide.md * Update docs/book/user-guide/starter-guide/create-an-ml-pipeline.md * Update docs/book/user-guide/starter-guide/create-an-ml-pipeline.md * Update docs/book/user-guide/starter-guide/create-an-ml-pipeline.md * Update docs/book/user-guide/starter-guide/create-an-ml-pipeline.md * Update docs/book/user-guide/starter-guide/create-an-ml-pipeline.md * Update docs/book/user-guide/starter-guide/cache-previous-executions.md * Update docs/book/user-guide/starter-guide/fetching-pipelines.md * Update docs/book/user-guide/starter-guide/fetching-pipelines.md * Update docs/book/user-guide/starter-guide/fetching-pipelines.md * Update docs/book/user-guide/starter-guide/fetching-pipelines.md * Update docs/book/user-guide/starter-guide/fetching-pipelines.md * projects reworked * Update docs/book/user-guide/starter-guide/fetching-pipelines.md * Update docs/book/user-guide/starter-guide/manage-artifacts.md * Update docs/book/user-guide/starter-guide/fetching-pipelines.md * Apply suggestions from code review * Update docs/book/user-guide/starter-guide/fetching-pipelines.md * Apply suggestions from code review * learning section * learning section * adding slight more info * Apply suggestions from code review * Apply suggestions from code review * Best of times * Update docs/book/getting-started/core-concepts.md Co-authored-by: Barış Can Durak <36421093+bcdurak@users.noreply.github.com> * Update docs/book/user-guide/starter-guide/starter-guide.md Co-authored-by: Barış Can Durak <36421093+bcdurak@users.noreply.github.com> * Latest review comments * Optimised images with calibre/image-actions * Latest review comments * Removed * Renamed to log_model_metadata * More stuff for materializers * tags * small data * Slimmed down * Added scarf --------- 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 109a8b5)

htahir1 added 30 commits November 22, 2023 18:03

latest

48b0aa1

latest

712299f

Merge branch 'doc/OSS-2491-OSS-2480-OSS-2481-refactor-docs' into doc/…

8314dcb

…update-starter-guide

latest

e2229a7

latest

749c23b

latest

b9d7734

latest

6a04029

Merge remote-tracking branch 'origin/doc/OSS-2491-OSS-2480-OSS-2481-r…

e4065dc

…efactor-docs' into doc/update-starter-guide

latest

afa47fa

Concepts

934be70

latest

45b6c7e

latest

011d705

latest

ae77d56

latest

fe28f14

latest

6f836b9

latest

7410e36

latest

19b1f09

latest

f07c9ca

Lean starter

2de5b89

Merge branch 'doc/OSS-2491-OSS-2480-OSS-2481-refactor-docs' into doc/…

4ed42a5

…update-starter-guide

new TOC

8c4fad9

latest

c10d1bb

latest

b520182

latest

e0c670f

latest

bf2a3af

latest

cd4ed00

Merge branch 'doc/OSS-2491-OSS-2480-OSS-2481-refactor-docs' into doc/…

53b45a8

…update-starter-guide

Merge branch 'doc/OSS-2491-OSS-2480-OSS-2481-refactor-docs' into doc/…

12134d0

…update-starter-guide

latest

dd045ba

latest

1ce97a9

htahir1 and others added 12 commits January 2, 2024 17:12

learning section

317bb0b

learning section

e1db694

adding slight more info

5c5e5c8

Apply suggestions from code review

a7bb9cb

Apply suggestions from code review

51fbdf0

Best of times

f98be55

Merge branch 'doc/update-starter-guide' of github.com:zenml-io/zenml …

1861b1d

…into doc/update-starter-guide

Merge remote-tracking branch 'origin/develop' into doc/update-starter…

f20fb77

…-guide

Update docs/book/getting-started/core-concepts.md

4ca679d

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

Update docs/book/user-guide/starter-guide/starter-guide.md

a869e06

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

Latest review comments

9bd090b

Optimised images with calibre/image-actions

4dfd27c

htahir1 added 9 commits January 3, 2024 13:26

Latest review comments

972408b

Merge branch 'doc/update-starter-guide' of github.com:zenml-io/zenml …

e704e5e

…into doc/update-starter-guide

Removed

03ac49e

Renamed to log_model_metadata

88fcc3e

Merge remote-tracking branch 'origin/develop' into doc/update-starter…

342fa36

…-guide

More stuff for materializers

ad25d43

tags

44d18af

small data

8c7e1d8

Slimmed down

43bd547

strickvl requested review from bcdurak and strickvl January 4, 2024 10:45

strickvl reviewed Jan 4, 2024

View reviewed changes

docs/book/.gitbook/assets/artifact_visualization_dashboard (4) (1).png Outdated Show resolved Hide resolved

strickvl approved these changes Jan 4, 2024

View reviewed changes

Added scarf

d19266f

htahir1 merged commit 109a8b5 into develop Jan 4, 2024
6 checks passed

htahir1 deleted the doc/update-starter-guide branch January 4, 2024 11:39

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Update starter and create new production guide #2143

Update starter and create new production guide #2143

htahir1 commented Dec 13, 2023

github-actions bot commented Jan 3, 2024

strickvl left a comment

strickvl Jan 4, 2024

strickvl Jan 4, 2024

strickvl Jan 4, 2024

		- [Metadata](logging-metadata.md) which is associated with various components of ZenML.

		This guide dives deeper into the management of this data.

Update starter and create new production guide #2143

Update starter and create new production guide #2143

Conversation

htahir1 commented Dec 13, 2023

Describe changes

Pre-requisites

Types of changes

github-actions bot commented Jan 3, 2024

strickvl left a comment

Choose a reason for hiding this comment

strickvl Jan 4, 2024

Choose a reason for hiding this comment

strickvl Jan 4, 2024

Choose a reason for hiding this comment

strickvl Jan 4, 2024

Choose a reason for hiding this comment