Skip to content
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] Restructure how-to section to make it more readable #3147

Merged
merged 25 commits into from
Oct 28, 2024
Merged
Show file tree
Hide file tree
Changes from 2 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
105 changes: 105 additions & 0 deletions .gitbook.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -17,3 +17,108 @@ redirects:
how-to/stack-deployment/implement-a-custom-integration: how-to/contribute-to-zenml/implement-a-custom-integration.md
how-to/setting-up-a-project-repository/best-practices: how-to/setting-up-a-project-repository/set-up-repository.md
getting-started/zenml-pro/system-architectures: getting-started/system-architectures.md

# Project Setup redirects
how-to/setting-up-a-project-repository/README.md: how-to/project-setup-and-management/setting-up-a-project-repository/README.md
how-to/setting-up-a-project-repository/set-up-repository.md: how-to/project-setup-and-management/setting-up-a-project-repository/set-up-repository.md
how-to/setting-up-a-project-repository/connect-your-git-repository.md: how-to/project-setup-and-management/setting-up-a-project-repository/connect-your-git-repository.md
how-to/setting-up-a-project-repository/using-project-templates.md: how-to/project-setup-and-management/setting-up-a-project-repository/using-project-templates.md
how-to/setting-up-a-project-repository/create-your-own-template.md: how-to/project-setup-and-management/setting-up-a-project-repository/create-your-own-template.md
how-to/setting-up-a-project-repository/shared-components-for-teams.md: how-to/project-setup-and-management/setting-up-a-project-repository/shared-components-for-teams.md
how-to/setting-up-a-project-repository/stacks-pipelines-models.md: how-to/project-setup-and-management/setting-up-a-project-repository/stacks-pipelines-models.md
how-to/setting-up-a-project-repository/access-management.md: how-to/project-setup-and-management/setting-up-a-project-repository/access-management.md

how-to/develop-locally/README.md: how-to/project-setup-and-management/develop-locally/README.md
how-to/develop-locally/local-prod-pipeline-variants.md: how-to/project-setup-and-management/develop-locally/local-prod-pipeline-variants.md
how-to/develop-locally/keep-your-dashboard-server-clean.md: how-to/project-setup-and-management/develop-locally/keep-your-dashboard-server-clean.md

how-to/connecting-to-zenml/README.md: how-to/project-setup-and-management/connecting-to-zenml/README.md
how-to/connecting-to-zenml/connect-in-with-your-user-interactive.md: how-to/project-setup-and-management/connecting-to-zenml/connect-in-with-your-user-interactive.md
how-to/connecting-to-zenml/connect-with-a-service-account.md: how-to/project-setup-and-management/connecting-to-zenml/connect-with-a-service-account.md

# Pipeline Development redirects
how-to/build-pipelines/README.md: how-to/pipeline-development/build-pipelines/README.md
how-to/build-pipelines/use-pipeline-step-parameters.md: how-to/pipeline-development/build-pipelines/use-pipeline-step-parameters.md
how-to/build-pipelines/configuring-a-pipeline-at-runtime.md: how-to/pipeline-development/build-pipelines/configuring-a-pipeline-at-runtime.md
how-to/build-pipelines/reference-environment-variables-in-configurations.md: how-to/pipeline-development/build-pipelines/reference-environment-variables-in-configurations.md
how-to/build-pipelines/step-output-typing-and-annotation.md: how-to/pipeline-development/build-pipelines/step-output-typing-and-annotation.md
how-to/build-pipelines/control-caching-behavior.md: how-to/pipeline-development/build-pipelines/control-caching-behavior.md
how-to/build-pipelines/schedule-a-pipeline.md: how-to/pipeline-development/build-pipelines/schedule-a-pipeline.md
how-to/build-pipelines/delete-a-pipeline.md: how-to/pipeline-development/build-pipelines/delete-a-pipeline.md
how-to/build-pipelines/compose-pipelines.md: how-to/pipeline-development/build-pipelines/compose-pipelines.md
how-to/build-pipelines/dynamically-assign-artifact-names.md: how-to/pipeline-development/build-pipelines/dynamically-assign-artifact-names.md
how-to/build-pipelines/retry-steps.md: how-to/pipeline-development/build-pipelines/retry-steps.md
how-to/build-pipelines/run-pipelines-asynchronously.md: how-to/pipeline-development/build-pipelines/run-pipelines-asynchronously.md
how-to/build-pipelines/control-execution-order-of-steps.md: how-to/pipeline-development/build-pipelines/control-execution-order-of-steps.md
how-to/build-pipelines/using-a-custom-step-invocation-id.md: how-to/pipeline-development/build-pipelines/using-a-custom-step-invocation-id.md
how-to/build-pipelines/name-your-pipeline-runs.md: how-to/pipeline-development/build-pipelines/name-your-pipeline-runs.md
how-to/build-pipelines/tag-your-pipeline-runs.md: how-to/pipeline-development/build-pipelines/tag-your-pipeline-runs.md
how-to/build-pipelines/use-failure-success-hooks.md: how-to/pipeline-development/build-pipelines/use-failure-success-hooks.md
how-to/build-pipelines/hyper-parameter-tuning.md: how-to/pipeline-development/build-pipelines/hyper-parameter-tuning.md
how-to/build-pipelines/access-secrets-in-a-step.md: how-to/pipeline-development/build-pipelines/access-secrets-in-a-step.md
how-to/build-pipelines/run-an-individual-step.md: how-to/pipeline-development/build-pipelines/run-an-individual-step.md
how-to/build-pipelines/fetching-pipelines.md: how-to/pipeline-development/build-pipelines/fetching-pipelines.md
how-to/build-pipelines/get-past-pipeline-step-runs.md: how-to/pipeline-development/build-pipelines/get-past-pipeline-step-runs.md

how-to/trigger-pipelines/README.md: how-to/pipeline-development/trigger-pipelines/README.md
how-to/trigger-pipelines/use-templates-python.md: how-to/pipeline-development/trigger-pipelines/use-templates-python.md
how-to/trigger-pipelines/use-templates-dashboard.md: how-to/pipeline-development/trigger-pipelines/use-templates-dashboard.md
how-to/trigger-pipelines/use-templates-rest-api.md: how-to/pipeline-development/trigger-pipelines/use-templates-rest-api.md

how-to/use-configuration-files/README.md: how-to/pipeline-development/use-configuration-files/README.md
how-to/use-configuration-files/how-to-use-config.md: how-to/pipeline-development/use-configuration-files/how-to-use-config.md
how-to/use-configuration-files/what-can-be-configured.md: how-to/pipeline-development/use-configuration-files/what-can-be-configured.md
how-to/use-configuration-files/runtime-configuration.md: how-to/pipeline-development/use-configuration-files/runtime-configuration.md
how-to/use-configuration-files/configuration-hierarchy.md: how-to/pipeline-development/use-configuration-files/configuration-hierarchy.md
how-to/use-configuration-files/retrieve-used-configuration-of-a-run.md: how-to/pipeline-development/use-configuration-files/retrieve-used-configuration-of-a-run.md
how-to/use-configuration-files/autogenerate-a-template-yaml-file.md: how-to/pipeline-development/use-configuration-files/autogenerate-a-template-yaml-file.md

# Data and Artifact Management redirects
how-to/handle-data-artifacts/README.md: how-to/data-artifact-management/handle-data-artifacts/README.md
how-to/handle-data-artifacts/artifact-versioning.md: how-to/data-artifact-management/handle-data-artifacts/artifact-versioning.md
how-to/handle-data-artifacts/return-multiple-outputs-from-a-step.md: how-to/data-artifact-management/handle-data-artifacts/return-multiple-outputs-from-a-step.md
how-to/handle-data-artifacts/delete-an-artifact.md: how-to/data-artifact-management/handle-data-artifacts/delete-an-artifact.md
how-to/handle-data-artifacts/tagging.md: how-to/data-artifact-management/handle-data-artifacts/tagging.md
how-to/handle-data-artifacts/get-arbitrary-artifacts-in-a-step.md: how-to/data-artifact-management/handle-data-artifacts/get-arbitrary-artifacts-in-a-step.md
how-to/handle-data-artifacts/handle-custom-data-types.md: how-to/data-artifact-management/handle-data-artifacts/handle-custom-data-types.md
how-to/handle-data-artifacts/load-artifacts-into-memory.md: how-to/data-artifact-management/handle-data-artifacts/load-artifacts-into-memory.md
how-to/handle-data-artifacts/datasets.md: how-to/data-artifact-management/handle-data-artifacts/datasets.md
how-to/handle-data-artifacts/manage-big-data.md: how-to/data-artifact-management/handle-data-artifacts/manage-big-data.md
how-to/handle-data-artifacts/unmaterialized-artifacts.md: how-to/data-artifact-management/handle-data-artifacts/unmaterialized-artifacts.md
how-to/handle-data-artifacts/passing-artifacts-between-pipelines.md: how-to/data-artifact-management/handle-data-artifacts/passing-artifacts-between-pipelines.md
how-to/handle-data-artifacts/registering-existing-data.md: how-to/data-artifact-management/handle-data-artifacts/registering-existing-data.md

how-to/visualize-artifacts/README.md: how-to/data-artifact-management/visualize-artifacts/README.md
how-to/visualize-artifacts/types-of-visualizations.md: how-to/data-artifact-management/visualize-artifacts/types-of-visualizations.md
how-to/visualize-artifacts/creating-custom-visualizations.md: how-to/data-artifact-management/visualize-artifacts/creating-custom-visualizations.md
how-to/visualize-artifacts/visualizations-in-dashboard.md: how-to/data-artifact-management/visualize-artifacts/visualizations-in-dashboard.md
how-to/visualize-artifacts/disabling-visualizations.md: how-to/data-artifact-management/visualize-artifacts/disabling-visualizations.md

# Model Management redirects
how-to/use-the-model-control-plane/README.md: how-to/model-management-metrics/model-control-plane/README.md
how-to/use-the-model-control-plane/register-a-model.md: how-to/model-management-metrics/model-control-plane/register-a-model.md
how-to/use-the-model-control-plane/delete-a-model.md: how-to/model-management-metrics/model-control-plane/delete-a-model.md
how-to/use-the-model-control-plane/associate-a-pipeline-with-a-model.md: how-to/model-management-metrics/model-control-plane/associate-a-pipeline-with-a-model.md
how-to/use-the-model-control-plane/connecting-artifacts-via-a-model.md: how-to/model-management-metrics/model-control-plane/connecting-artifacts-via-a-model.md
how-to/use-the-model-control-plane/model-versions.md: how-to/model-management-metrics/model-control-plane/model-versions.md
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

left side should not end in .md

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

yes, fixing it!

how-to/use-the-model-control-plane/load-a-model-in-code.md: how-to/model-management-metrics/model-control-plane/load-a-model-in-code.md
how-to/use-the-model-control-plane/promote-a-model.md: how-to/model-management-metrics/model-control-plane/promote-a-model.md
how-to/use-the-model-control-plane/linking-model-binaries-data-to-models.md: how-to/model-management-metrics/model-control-plane/linking-model-binaries-data-to-models.md
how-to/use-the-model-control-plane/load-artifacts-from-model.md: how-to/model-management-metrics/model-control-plane/load-artifacts-from-model.md

how-to/track-metrics-metadata/README.md: how-to/model-management-metrics/track-metrics-metadata/README.md
how-to/track-metrics-metadata/attach-metadata-to-a-model.md: how-to/model-management-metrics/track-metrics-metadata/attach-metadata-to-a-model.md
how-to/track-metrics-metadata/attach-metadata-to-an-artifact.md: how-to/model-management-metrics/track-metrics-metadata/attach-metadata-to-an-artifact.md
how-to/track-metrics-metadata/attach-metadata-to-steps.md: how-to/model-management-metrics/track-metrics-metadata/attach-metadata-to-steps.md
how-to/track-metrics-metadata/grouping-metadata.md: how-to/model-management-metrics/track-metrics-metadata/grouping-metadata.md
how-to/track-metrics-metadata/logging-metadata.md: how-to/model-management-metrics/track-metrics-metadata/logging-metadata.md
how-to/track-metrics-metadata/fetch-metadata-within-steps.md: how-to/model-management-metrics/track-metrics-metadata/fetch-metadata-within-steps.md
how-to/track-metrics-metadata/fetch-metadata-within-pipeline.md: how-to/model-management-metrics/track-metrics-metadata/fetch-metadata-within-pipeline.md

# Infrastructure redirects
how-to/stack-deployment/README.md: how-to/infrastructure-deployment/stack-deployment/README.md
how-to/stack-deployment/deploy-a-cloud-stack.md: how-to/infrastructure-deployment/stack-deployment/deploy-a-cloud-stack.md
how-to/stack-deployment/deploy-a-cloud-stack-with-terraform.md: how-to/infrastructure-deployment/stack-deployment/deploy-a-cloud-stack-with-terraform.md
how-to/stack-deployment/register-a-cloud-stack.md: how-to/infrastructure-deployment/stack-deployment/register-a-cloud-stack.md
how-to/stack-deployment/reference-secrets-in-stack-configuration.md: how-to/infrastructure-deployment/stack-deployment/reference-secrets-in-stack-configuration.md
how-to/stack-deployment/implement-a-custom-stack-component.md: how-to/infrastructure-deployment/stack-deployment/implement-a-custom-stack-component.md
3 changes: 3 additions & 0 deletions docs/book/how-to/advanced-topics/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# Advanced Topics

This section covers advanced features and configurations in ZenML.
3 changes: 3 additions & 0 deletions docs/book/how-to/data-artifact-management/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# Data and Artifact Management

This section covers all aspects of managing data and artifacts in ZenML.
3 changes: 3 additions & 0 deletions docs/book/how-to/infrastructure-deployment/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# Infrastructure and Deployment

This section covers all aspects of infrastructure setup and deployment in ZenML.
3 changes: 3 additions & 0 deletions docs/book/how-to/model-management-metrics/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# Model Management and Metrics

This section covers all aspects of managing models and tracking metrics in ZenML.
3 changes: 3 additions & 0 deletions docs/book/how-to/pipeline-development/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# Pipeline Development

This section covers all aspects of pipeline development in ZenML.
3 changes: 3 additions & 0 deletions docs/book/how-to/project-setup-and-management/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# Project Setup and Management

This section covers all aspects of setting up and managing ZenML projects.
Loading