Skip to content

Commit 2c6ea7a

Browse files
strickvlgithub-actions[bot]Claude
committed
Add 5-min quick wins page to docs (#3633)
* Fix link * Add quick wins guide + photo * Remove line breaks * Fix broken slack alerter link * Fixes based on PR feedback * Optimised images with calibre/image-actions * Addressing Marwan's comments * Handle installed docker * Add tag filtering image * Fix deleted text * Add stack requirements installation to parent Docker image guide Added instructions to install stack component requirements in the parent Docker image to ensure all required dependencies for the stack are available. This enhances the quick win by ensuring the parent image is fully prepared for all stack components. 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <[email protected]> * API & SDK docs fixes --------- Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com> Co-authored-by: Claude <[email protected]> (cherry picked from commit 9285c4d)
1 parent 446454f commit 2c6ea7a

File tree

12 files changed

+810
-10
lines changed

12 files changed

+810
-10
lines changed

RELEASE_NOTES.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -5518,7 +5518,7 @@ zenml stack update new_default -c local2
55185518
zenml stack describe new_default
55195519
zenml stack remove-component -c
55205520
```
5521-
More details are in the [CLI docs](https://apidocs.zenml.io/0.7.3/cli/).
5521+
More details are in the [CLI docs](https://sdkdocs.zenml.io/0.82.0/cli.html).
55225522
Users can add new stack components to a pre-existing stack, or they can modify
55235523
already-present stack components. They can also rename their stack and individual stack components.
55245524
Loading
Loading

docs/book/component-guide/container-registries/dockerhub.md

-2
Original file line numberDiff line numberDiff line change
@@ -64,6 +64,4 @@ Additionally, we'll need to log in to the container registry so Docker can pull
6464
docker login
6565
```
6666

67-
For more information and a full list of configurable attributes of the `dockerhub` container registry, check out the [SDK Docs](https://apidocs.zenml.io/latest/core_code_docs/core-container_registries/#zenml.container_registries.dockerhub_container_registry.DockerHubContainerRegistry) .
68-
6967
<figure><img src="https://static.scarf.sh/a.png?x-pxid=f0b4f458-0a54-4fcd-aa95-d5ee424815bc" alt="ZenML Scarf"><figcaption></figcaption></figure>

docs/book/component-guide/data-validators/great-expectations.md

+2-6
Original file line numberDiff line numberDiff line change
@@ -158,7 +158,7 @@ def profiling_pipeline():
158158
profiling_pipeline()
159159
```
160160

161-
As can be seen from the [step definition](https://apidocs.zenml.io/latest/integration_code_docs/integrations-great_expectations/#zenml.integrations.great_expectations.steps.ge_profiler.great_expectations_profiler_step) , the step takes in a `pandas.DataFrame` dataset, and it returns a Great Expectations `ExpectationSuite` object:
161+
As can be seen from the step definition, the step takes in a `pandas.DataFrame` dataset, and it returns a Great Expectations `ExpectationSuite` object:
162162

163163
```python
164164
@step
@@ -172,8 +172,6 @@ def great_expectations_profiler_step(
172172
...
173173
```
174174

175-
You can view [the complete list of configuration parameters](https://apidocs.zenml.io/latest/integration_code_docs/integrations-great_expectations/#zenml.integrations.great_expectations.steps.ge_profiler.great_expectations_profiler_step) in the SDK docs.
176-
177175
#### The Great Expectations data validator step
178176

179177
The standard Great Expectations data validator step validates an input `pandas.DataFrame` dataset by running an existing Expectation Suite on it. The validation results are saved in the Great Expectations Validation Store, but also returned as an `CheckpointResult` artifact that is versioned and saved in the ZenML Artifact Store. The step automatically rebuilds the Data Docs.
@@ -219,7 +217,7 @@ def validation_pipeline():
219217
validation_pipeline()
220218
```
221219

222-
As can be seen from the [step definition](https://apidocs.zenml.io/latest/integration_code_docs/integrations-great_expectations/#zenml.integrations.great_expectations.steps.ge_validator.great_expectations_validator_step) , the step takes in a `pandas.DataFrame` dataset and a boolean `condition` and it returns a Great Expectations `CheckpointResult` object. The boolean `condition` is only used as a means of ordering steps in a pipeline (e.g. if you must force it to run only after the data profiling step generates an Expectation Suite):
220+
As can be seen from the step definition, the step takes in a `pandas.DataFrame` dataset and a boolean `condition` and it returns a Great Expectations `CheckpointResult` object. The boolean `condition` is only used as a means of ordering steps in a pipeline (e.g. if you must force it to run only after the data profiling step generates an Expectation Suite):
223221

224222
```python
225223
@step
@@ -232,8 +230,6 @@ def great_expectations_validator_step(
232230
) -> CheckpointResult:
233231
```
234232

235-
You can view [the complete list of configuration parameters](https://apidocs.zenml.io/latest/integration_code_docs/integrations-great_expectations/#zenml.integrations.great_expectations.steps.ge_validator.great_expectations_validator_step) in the SDK docs.
236-
237233
#### Call Great Expectations directly
238234

239235
You can use the Great Expectations library directly in your custom pipeline steps, while leveraging ZenML's capability of serializing, versioning and storing the `ExpectationSuite` and `CheckpointResult` objects in its Artifact Store. To use the Great Expectations configuration managed by ZenML while interacting with the Great Expectations library directly, you need to use the Data Context managed by ZenML instead of the default one provided by Great Expectations, e.g.:
Loading
Loading
Loading
Loading

docs/book/user-guide/best-practices/quick-wins.md

+805
Large diffs are not rendered by default.

docs/book/user-guide/toc.md

+1
Original file line numberDiff line numberDiff line change
@@ -59,6 +59,7 @@
5959

6060
## Best practices
6161

62+
* [5-minute Quick Wins](best-practices/quick-wins.md)
6263
* [Keep Your Dashboard Clean](best-practices/keep-your-dashboard-server-clean.md)
6364
* [Configure Python environments](best-practices/configure-python-environments.md)
6465
* [Shared Components for Teams](best-practices/shared-components-for-teams.md)

docs/book/user-guide/tutorial/managing-scheduled-pipelines.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ The orchestrator then takes over responsibility for executing the pipeline\
2323
according to the schedule.
2424

2525
{% hint style="info" %}
26-
For our full reference documentation on schedules, see the [Schedule a Pipeline](https://docs.zenml.io/user-guides/tutorial/managing-scheduled-pipelines) page.
26+
For our full reference documentation on schedules, see the [Schedule a Pipeline](https://docs.zenml.io/concepts/steps_and_pipelines/scheduling) page.
2727
{% endhint %}
2828

2929
### Prerequisites

0 commit comments

Comments
 (0)