[docs] Add icons to headers in docs (#3149)

wjayesh · web-flow · commit e3b8d7e46d5f · 2024-10-28T12:47:18.000+01:00
* add icons minus gitbook changes

* add icons minus gitbook changes

* add more
diff --git a/docs/book/component-guide/README.md b/docs/book/component-guide/README.md
@@ -1,8 +1,9 @@
 ---
+icon: scroll
 description: Overview of categories of MLOps components and third-party integrations.
 ---
 
-# 📜 Overview
+# Overview
 
 If you are new to the world of MLOps, it is often daunting to be immediately faced with a sea of tools that seemingly all promise and do the same things. It is useful in this case to try to categorize tools in various groups in order to understand their value in your toolchain in a more precise manner.
 
diff --git a/docs/book/component-guide/alerters/alerters.md b/docs/book/component-guide/alerters/alerters.md
@@ -1,5 +1,6 @@
 ---
 description: Sending automated alerts to chat services.
+icon: message-exclamation
 ---
 
 # Alerters
diff --git a/docs/book/component-guide/annotators/annotators.md b/docs/book/component-guide/annotators/annotators.md
@@ -1,4 +1,5 @@
 ---
+icon: expand
 description: Annotating the data in your workflow.
 ---
 
diff --git a/docs/book/component-guide/artifact-stores/artifact-stores.md b/docs/book/component-guide/artifact-stores/artifact-stores.md
@@ -1,5 +1,6 @@
 ---
 description: Setting up a persistent storage for your artifacts.
+icon: folder-closed
 ---
 
 # Artifact Stores
diff --git a/docs/book/component-guide/container-registries/container-registries.md b/docs/book/component-guide/container-registries/container-registries.md
@@ -1,4 +1,5 @@
 ---
+icon: box
 description: Setting up a storage for Docker images.
 ---
 
diff --git a/docs/book/component-guide/data-validators/data-validators.md b/docs/book/component-guide/data-validators/data-validators.md
@@ -1,4 +1,5 @@
 ---
+icon: chart-column
 description: >-
   How to enhance and maintain the quality of your data and the performance of
   your models with data profiling and validation
diff --git a/docs/book/component-guide/experiment-trackers/experiment-trackers.md b/docs/book/component-guide/experiment-trackers/experiment-trackers.md
@@ -1,5 +1,6 @@
 ---
 description: Logging and visualizing ML experiments.
+icon: clipboard
 ---
 
 # Experiment Trackers
diff --git a/docs/book/component-guide/feature-stores/feature-stores.md b/docs/book/component-guide/feature-stores/feature-stores.md
@@ -1,4 +1,5 @@
 ---
+icon: database
 description: Managing data in feature stores.
 ---
 
diff --git a/docs/book/component-guide/image-builders/image-builders.md b/docs/book/component-guide/image-builders/image-builders.md
@@ -1,4 +1,5 @@
 ---
+icon: box-open
 description: Building container images for your ML workflow.
 ---
 
diff --git a/docs/book/component-guide/model-deployers/model-deployers.md b/docs/book/component-guide/model-deployers/model-deployers.md
@@ -1,4 +1,5 @@
 ---
+icon: rocket
 description: Deploying your models and serve real-time predictions.
 ---
 
diff --git a/docs/book/component-guide/model-registries/model-registries.md b/docs/book/component-guide/model-registries/model-registries.md
@@ -1,4 +1,5 @@
 ---
+icon: table-rows
 description: Tracking and managing ML models.
 ---
 
diff --git a/docs/book/component-guide/orchestrators/orchestrators.md b/docs/book/component-guide/orchestrators/orchestrators.md
@@ -1,4 +1,5 @@
 ---
+icon: train-track
 description: Orchestrating the execution of ML pipelines.
 ---
 
diff --git a/docs/book/component-guide/step-operators/step-operators.md b/docs/book/component-guide/step-operators/step-operators.md
@@ -1,4 +1,5 @@
 ---
+icon: arrow-progress
 description: Executing individual steps in specialized environments.
 ---
 
diff --git a/docs/book/getting-started/core-concepts.md b/docs/book/getting-started/core-concepts.md
@@ -1,8 +1,9 @@
 ---
+icon: lightbulb
 description: Discovering the core concepts behind ZenML.
 ---
 
-# 🪄 Core concepts
+# Core concepts
 
 ![A diagram of core concepts of ZenML OSS](../.gitbook/assets/core_concepts_oss.png)
 
diff --git a/docs/book/getting-started/deploying-zenml/README.md b/docs/book/getting-started/deploying-zenml/README.md
@@ -1,8 +1,9 @@
 ---
+icon: rocket-launch
 description: Why do we need to deploy ZenML?
 ---
 
-# 🤔 Deploying ZenML
+# Deploying ZenML
 
 ![ZenML OSS server deployment architecture](../../.gitbook/assets/oss_simple_deployment.png)
 
diff --git a/docs/book/getting-started/installation.md b/docs/book/getting-started/installation.md
@@ -1,8 +1,9 @@
 ---
+icon: cauldron
 description: Installing ZenML and getting started.
 ---
 
-# 🧙 Installation
+# Installation
 
 **ZenML** is a Python package that can be installed directly via `pip`:
 
diff --git a/docs/book/getting-started/system-architectures.md b/docs/book/getting-started/system-architectures.md
@@ -1,8 +1,9 @@
 ---
+icon: building-columns
 description: Different variations of the ZenML architecture depending on your needs.
 ---
 
-# 🏛️ System Architecture
+# System Architecture
 
 This guide walks through the various ways that ZenML can be deployed, from self-hosted OSS, to
 SaaS, to self-hosted ZenML Pro!
diff --git a/docs/book/getting-started/zenml-pro/README.md b/docs/book/getting-started/zenml-pro/README.md
@@ -1,4 +1,9 @@
-# ☁️ ZenML Pro
+---
+icon: cloud
+description: Learn about the ZenML Pro features and deployment scenarios.
+---
+
+# ZenML Pro
 
 ![Walkthrough of ZenML Model Control Plane](../../.gitbook/assets/mcp_walkthrough.gif)
 
diff --git a/docs/book/how-to/auth-management/README.md b/docs/book/how-to/auth-management/README.md
@@ -1,10 +1,11 @@
 ---
+icon: plug
 description: >-
   Connect your ZenML deployment to a cloud provider and other infrastructure
   services and resources.
 ---
 
-# 🔌 Connect services (AWS, GCP, Azure, K8s etc)
+# Connect services (AWS, GCP, Azure, K8s etc)
 
 A production-grade MLOps platform involves interactions between a diverse combination of third-party libraries and external services sourced from various different vendors. One of the most daunting hurdles in building and operating an MLOps platform composed of multiple components is configuring and maintaining uninterrupted and secured access to the infrastructure resources and services that it consumes.
 
diff --git a/docs/book/how-to/build-pipelines/README.md b/docs/book/how-to/build-pipelines/README.md
@@ -1,10 +1,11 @@
 ---
+icon: flask
 description: >-
   Building pipelines is as simple as adding the `@step` and `@pipeline`
   decorators to your code.
 ---
 
-# ⛓️ Build a pipeline
+# Build a pipeline
 
 ```python
 @step  # Just add this decorator
diff --git a/docs/book/how-to/configure-python-environments/README.md b/docs/book/how-to/configure-python-environments/README.md
@@ -1,8 +1,9 @@
 ---
+icon: python
 description: Navigating multiple development environments.
 ---
 
-# 🐍 Configure python environments
+# Configure python environments
 
 ZenML deployments often involve multiple environments. This guide helps you manage dependencies and configurations across these environments.
 
diff --git a/docs/book/how-to/connecting-to-zenml/README.md b/docs/book/how-to/connecting-to-zenml/README.md
@@ -1,8 +1,9 @@
 ---
+icon: globe-pointer
 description: Various means of connecting to ZenML.
 ---
 
-# 🔌 Connect to a server
+# Connect to a server
 
 Once [ZenML is deployed](../../user-guide/production-guide/deploying-zenml.md), there are various ways to connect to it.&#x20;
 
diff --git a/docs/book/how-to/contribute-to-zenml/README.md b/docs/book/how-to/contribute-to-zenml/README.md
@@ -1,3 +1,8 @@
+---
+icon: handshake-simple
+description: Contributing to ZenML.
+---
+
 # Contribute to ZenML
 
 Thank you for considering contributing to ZenML!
diff --git a/docs/book/how-to/control-logging/README.md b/docs/book/how-to/control-logging/README.md
@@ -1,8 +1,9 @@
 ---
+icon: memo-circle-info
 description: Configuring ZenML's default logging behavior
 ---
 
-# 🌲 Control logging
+# Control logging
 
 ZenML produces various kinds of logs:
 
diff --git a/docs/book/how-to/customize-docker-builds/README.md b/docs/book/how-to/customize-docker-builds/README.md
@@ -1,8 +1,9 @@
 ---
+icon: docker
 description: Using Docker images to run your pipeline.
 ---
 
-# 🐳 Customize Docker Builds
+# Customize Docker Builds
 
 ZenML executes pipeline steps sequentially in the active Python environment when running locally. However, with remote [orchestrators](../../user-guide/production-guide/cloud-orchestration.md) or [step operators](../../component-guide/step-operators/step-operators.md), ZenML builds [Docker](https://www.docker.com/) images to run your pipeline in an isolated, well-defined environment.
 
diff --git a/docs/book/how-to/debug-and-solve-issues.md b/docs/book/how-to/debug-and-solve-issues.md
@@ -1,8 +1,9 @@
 ---
+icon: bug
 description: A guide to debug common issues and get help.
 ---
 
-# 🐞 Debug and solve issues
+#  Debug and solve issues
 
 If you stumbled upon this page, chances are you're facing issues with using ZenML. This page documents suggestions and best practices to let you debug, get help, and solve issues quickly.
 
diff --git a/docs/book/how-to/develop-locally/README.md b/docs/book/how-to/develop-locally/README.md
@@ -1,4 +1,5 @@
 ---
+icon: house
 description: Learn how to develop your pipelines locally.
 ---
 
diff --git a/docs/book/how-to/handle-data-artifacts/README.md b/docs/book/how-to/handle-data-artifacts/README.md
@@ -1,11 +1,12 @@
 ---
+icon: box-archive
 description: >-
   Step outputs in ZenML are stored in the artifact store. This enables caching,
   lineage and auditability. Using type annotations helps with transparency, 
   passing data between steps, and serializing/deserializing the data.
 ---
 
-# 🗄️ Handle Data/Artifacts
+# Handle Data/Artifacts
 
 For best results, use type annotations for your outputs. This is good coding practice for transparency, helps ZenML handle passing data between steps, and also enables ZenML to serialize and deserialize (referred to as 'materialize' in ZenML) the data.
 
diff --git a/docs/book/how-to/interact-with-secrets.md b/docs/book/how-to/interact-with-secrets.md
@@ -1,8 +1,9 @@
 ---
+icon: user-secret
 description: Registering and using secrets.
 ---
 
-# 🔐 Interact with secrets
+# Interact with secrets
 
 ## What is a ZenML secret?
 
diff --git a/docs/book/how-to/manage-the-zenml-server/README.md b/docs/book/how-to/manage-the-zenml-server/README.md
@@ -1,3 +1,7 @@
+---
+icon: wand-magic-sparkles
+---
+
 # Manage your ZenML server
 
 This section contains guides to help you learn the best practices for upgrading your ZenML server, tips on how to use the ZenML server in production, and how to troubleshoot it.
diff --git a/docs/book/how-to/popular-integrations/README.md b/docs/book/how-to/popular-integrations/README.md
@@ -1,8 +1,9 @@
 ---
+icon: puzzle-piece
 description: Use your favorite tools with ZenML.
 ---
 
-# 👨‍🎤 Popular integrations
+# Popular integrations
 
 ZenML is designed to work seamlessly with your favorite tools. This guide will
 show you how to integrate ZenML with some of the most popular tools in the data
diff --git a/docs/book/how-to/run-remote-steps-and-pipelines-from-notebooks/README.md b/docs/book/how-to/run-remote-steps-and-pipelines-from-notebooks/README.md
@@ -1,8 +1,9 @@
 ---
+icon: notebook
 description: Use Jupyter Notebooks to run remote steps or pipelines
 ---
 
-# 📔 Run remote pipelines from notebooks
+# Run remote pipelines from notebooks
 
 ZenML steps and pipelines can be defined in a Jupyter notebook and executed remotely. To do so, ZenML will extract the code from your notebook cells and run them as Python modules inside the Docker containers that execute your pipeline steps remotely. For this to work, the notebook cells in which you define your steps need to meet certain conditions.
 
diff --git a/docs/book/how-to/setting-up-a-project-repository/README.md b/docs/book/how-to/setting-up-a-project-repository/README.md
@@ -1,8 +1,9 @@
 ---
+icon: paw
 description: Setting your team up for success with a well-architected ZenML project.
 ---
 
-# 😸 Setting up a Well-Architected ZenML Project
+# Setting up a Well-Architected ZenML Project
 
 Welcome to the guide on setting up a well-architected ZenML project. This section will provide you with a comprehensive overview of best practices, strategies, and considerations for structuring your ZenML projects to ensure scalability, maintainability, and collaboration within your team.
 
diff --git a/docs/book/how-to/stack-deployment/README.md b/docs/book/how-to/stack-deployment/README.md
@@ -1,4 +1,5 @@
 ---
+icon: screwdriver-wrench
 description: >
   Stacks represent the infrastructure and tooling that defines where and how a pipeline executes.
 ---
diff --git a/docs/book/how-to/track-metrics-metadata/README.md b/docs/book/how-to/track-metrics-metadata/README.md
@@ -1,8 +1,9 @@
 ---
+icon: ufo-beam
 description: Tracking metrics and metadata
 ---
 
-# 📈 Track metrics and metadata
+# Track metrics and metadata
 
 Logging metrics and metadata is standardized in ZenML. The most common pattern is to use the `log_xxx` methods, e.g.:
 
diff --git a/docs/book/how-to/training-with-gpus/training-with-gpus.md b/docs/book/how-to/training-with-gpus/training-with-gpus.md
@@ -1,4 +1,5 @@
 ---
+icon: microchip-ai
 description: Ensuring your pipelines or steps run on GPU-backed hardware.
 ---
 
diff --git a/docs/book/how-to/trigger-pipelines/README.md b/docs/book/how-to/trigger-pipelines/README.md
@@ -1,7 +1,10 @@
 ---
+icon: bell-concierge
 description: There are numerous ways to trigger a pipeline
 ---
 
+# Trigger a pipeline
+
 In ZenML, the simplest way to execute a run is to use your pipeline function:
 
 ```python
diff --git a/docs/book/how-to/use-configuration-files/README.md b/docs/book/how-to/use-configuration-files/README.md
@@ -1,8 +1,9 @@
 ---
+icon: file-lines
 description: ZenML makes it easy to configure and run a pipeline with configuration files.
 ---
 
-# 📃 Use configuration files
+# Use configuration files
 
 ZenML pipelines can be configured at runtime with a simple YAML file that can help you set [parameters](../build-pipelines/use-pipeline-step-parameters.md), control [caching behavior](../build-pipelines/control-caching-behavior.md) or even configure different stack components.
 
diff --git a/docs/book/how-to/use-the-model-control-plane/README.md b/docs/book/how-to/use-the-model-control-plane/README.md
@@ -1,4 +1,8 @@
-# 🪆 Use the Model Control Plane
+---
+icon: tower-control
+---
+
+# Use the Model Control Plane
 
 ![Walkthrough of ZenML Model Control Plane (Dashboard available only on ZenML Pro)](../../.gitbook/assets/mcp_walkthrough.gif)
 
diff --git a/docs/book/how-to/visualize-artifacts/README.md b/docs/book/how-to/visualize-artifacts/README.md
@@ -1,4 +1,5 @@
 ---
+icon: chart-scatter
 description: Configuring ZenML to display data visualizations in the dashboard.
 ---
 
diff --git a/docs/book/introduction.md b/docs/book/introduction.md
@@ -1,8 +1,9 @@
 ---
+icon: torii-gate
 description: Welcome to ZenML!
 ---
 
-# ⭐ Introduction
+# Introduction
 
 **ZenML** is an extensible, open-source MLOps framework for creating portable, production-ready machine learning pipelines. By decoupling infrastructure from code, ZenML enables developers across your organization to collaborate more effectively as they develop to production.
 
diff --git a/docs/book/reference/api-reference.md b/docs/book/reference/api-reference.md
@@ -1,8 +1,9 @@
 ---
+icon: ruler
 description: See the ZenML API reference.
 ---
 
-# 👀 API reference
+# API reference
 
 The ZenML server is a FastAPI application, therefore the OpenAPI-compliant docs are available at `/docs` or `/redoc`
 of your ZenML server:
diff --git a/docs/book/reference/community-and-content.md b/docs/book/reference/community-and-content.md
@@ -1,8 +1,9 @@
 ---
+icon: heart
 description: All possible ways for our community to get in touch with ZenML.
 ---
 
-# 💜 Community & content
+# Community & content
 
 The ZenML team and community have put together a list of references that can be used to get in touch with the
 development team of ZenML and develop a deeper understanding of the framework.
diff --git a/docs/book/reference/environment-variables.md b/docs/book/reference/environment-variables.md
diff --git a/docs/book/reference/faq.md b/docs/book/reference/faq.md
diff --git a/docs/book/reference/global-settings.md b/docs/book/reference/global-settings.md
diff --git a/docs/book/reference/how-do-i.md b/docs/book/reference/how-do-i.md
diff --git a/docs/book/reference/python-client.md b/docs/book/reference/python-client.md
diff --git a/docs/book/toc.md b/docs/book/toc.md
diff --git a/docs/book/user-guide/llmops-guide/README.md b/docs/book/user-guide/llmops-guide/README.md
diff --git a/docs/book/user-guide/production-guide/production-guide.md b/docs/book/user-guide/production-guide/production-guide.md
diff --git a/docs/book/user-guide/starter-guide/starter-guide.md b/docs/book/user-guide/starter-guide/starter-guide.md
