docs: update docs Links (#609)

Cahllagerfeld · web-flow · commit 094092a49de6 · 2024-06-06T08:49:31.000+02:00
diff --git a/README.md b/README.md
@@ -103,7 +103,7 @@ To get started with the ZenML Dashboard, follow these steps:
 
    - Access the dashboard at `http://localhost:8080`
 
-For detailed deployment instructions and additional options, refer to the [deployment guide](https://docs.zenml.io/user-guide/starter-guide/switch-to-production).
+For detailed deployment instructions and additional options, refer to the [deployment guide](https://docs.zenml.io/user-guide/production-guide/deploying-zenml).
 
 Now you're ready to explore and visualize your ML pipelines, stacks, and artifacts with the ZenML Dashboard!
 
diff --git a/legacy/src/constants/constantCommands.ts b/legacy/src/constants/constantCommands.ts
@@ -1,7 +1,7 @@
 export const constantCommandsToCreateStack = {
   title: 'Stack Cheatsheet',
   documentation:
-    'https://docs.zenml.io/user-guide/starter-guide/understand-stacks',
+    'https://docs.zenml.io/user-guide/production-guide/understand-stacks',
   body: [
     {
       text: 'Register a stack',
@@ -32,12 +32,12 @@ export const constantCommandsToCreateStack = {
 export const constantCommandsToCreateSecret = {
   title: 'Stack Cheatsheet',
   documentation:
-    'https://docs.zenml.io/user-guide/advanced-guide/secret-management',
+    'https://docs.zenml.io/getting-started/deploying-zenml/manage-the-deployed-services/secret-management',
 };
 
 export const constantCommandsToCreateRepository = {
   documentation:
-    'https://docs.zenml.io/user-guide/advanced-guide/environment-management/connect-your-git-repository',
+    'https://docs.zenml.io/how-to/setting-up-a-project-repository/connect-your-git-repository',
 };
 
 export const constantCommandsToCreatePipeline = {
@@ -105,7 +105,7 @@ export const constantCommandsToCreateRuns = {
 
 export const constantCommandsToCreateComponent = {
   documentation:
-    'https://docs.zenml.io/user-guide/starter-guide/understand-stacks',
+    'https://docs.zenml.io/user-guide/production-guide/understand-stacks',
   componentCommand: {
     type: 'alerter',
     body: [
diff --git a/legacy/src/ui/components/lineage/sidebarTabsSwitchers/ArtifactVisualization.tsx b/legacy/src/ui/components/lineage/sidebarTabsSwitchers/ArtifactVisualization.tsx
@@ -219,7 +219,7 @@ const ArtifactVisualization = ({
           <a
             rel="noopener noreferrer"
             target="_blank"
-            href="https://docs.zenml.io/stacks-and-components/component-guide/artifact-stores/custom"
+            href="https://docs.zenml.io/stack-components/artifact-stores/custom"
           >
             docs
           </a>
diff --git a/legacy/src/ui/layouts/common/layouts/AuthenticatedLayout/DeploymentBanner/index.tsx b/legacy/src/ui/layouts/common/layouts/AuthenticatedLayout/DeploymentBanner/index.tsx
@@ -10,15 +10,15 @@ function DeploymentBanner() {
         <a
           target="_blank"
           rel="noopener noreferrer"
-          href="https://docs.zenml.io/user-guide/starter-guide/switch-to-production"
+          href="https://docs.zenml.io/getting-started/deploying-zenml"
         >
           deploy ZenML yourself
         </a>
         , or get a hosted version with{' '}
         <a
           target="_blank"
           rel="noopener noreferrer"
-          href="https://docs.zenml.io/deploying-zenml/zenml-cloud"
+          href="https://docs.zenml.io/getting-started/zenml-pro"
         >
           {' '}
           ZenML Cloud
diff --git a/legacy/src/ui/layouts/plugins/shared/Layout.tsx b/legacy/src/ui/layouts/plugins/shared/Layout.tsx
@@ -1,6 +1,6 @@
 import React from 'react';
 
-import { FlexBox, H2, Paragraph } from '../../../components';
+import { FlexBox, H2 } from '../../../components';
 
 export const PluginsLayout: React.FC<{
   title: string;
@@ -11,46 +11,6 @@ export const PluginsLayout: React.FC<{
       <FlexBox flexDirection="row" style={{ gap: '8px' }}>
         <FlexBox flexDirection="column">
           <H2 style={{ fontWeight: 500 }}>{title}</H2>
-
-          <Paragraph style={{ marginTop: '8px' }}>
-            The ZenML Hub is a{' '}
-            <a
-              target="_blank"
-              rel="noopener noreferrer"
-              href="https://blog.zenml.io/zenml-hub-launch/"
-            >
-              plugin system
-            </a>{' '}
-            that allows users to contribute and consume stack component flavors,
-            pipelines, steps, materializers, and other pieces of code seamlessly
-            in their ML pipelines. Below are a list of community contributed
-            plugins. If you would like to create your own plugin, click{' '}
-            <a
-              target="_blank"
-              rel="noopener noreferrer"
-              href="https://docs.zenml.io/user-guide/advanced-guide/environment-management/use-the-hub"
-            >
-              here
-            </a>
-            .
-          </Paragraph>
-        </FlexBox>
-        <FlexBox
-          fullWidth
-          flexDirection="column"
-          alignItems="end"
-          justifyContent="flex-end"
-        >
-          <Paragraph color="grey" style={{ fontSize: '14px', flexShrink: 0 }}>
-            Check out our easy to read{' '}
-            <a
-              href="https://docs.zenml.io/user-guide/advanced-guide/environment-management/use-the-hub"
-              target="__blank"
-              rel="noopener noreferrer"
-            >
-              docs
-            </a>
-          </Paragraph>
         </FlexBox>
       </FlexBox>
 
diff --git a/legacy/src/ui/layouts/session/UserEmail/index.tsx b/legacy/src/ui/layouts/session/UserEmail/index.tsx
@@ -91,7 +91,7 @@ const UserEmail: React.FC = () => {
                   <InnerTextLink
                     text={'Click Here'}
                     href={
-                      'https://docs.zenml.io/user-guide/advanced-guide/environment-management/global-settings-of-zenml#usage-analytics'
+                      'https://docs.zenml.io/reference/global-settings#usage-analytics'
                     }
                   />
                   &nbsp;{translate('subtitle2-2')}
diff --git a/legacy/src/ui/layouts/stacks/Header/index.tsx b/legacy/src/ui/layouts/stacks/Header/index.tsx
@@ -76,7 +76,7 @@ const HeaderWithButtons: React.FC<{
         <a
           target="_blank"
           rel="noopener noreferrer"
-          href="https://docs.zenml.io/stacks-and-components/stack-deployment"
+          href="https://docs.zenml.io/how-to/stack-deployment"
         >
           deploy a MLOps stack
         </a>{' '}
diff --git a/src/app/onboarding/ProductionSetup/ArtifactStore.tsx b/src/app/onboarding/ProductionSetup/ArtifactStore.tsx
@@ -182,7 +182,7 @@ function OtherStore() {
 						emphasis: "subtle",
 						size: "md"
 					})}
-					href="https://docs.zenml.io/stacks-and-components/custom-stack-solutions/implement-a-custom-stack-component"
+					href="https://docs.zenml.io/how-to/stack-deployment/implement-a-custom-stack-component"
 				>
 					How to create a custom artifact store
 				</a>
diff --git a/src/app/onboarding/ProductionSetup/ConnectorContent.tsx b/src/app/onboarding/ProductionSetup/ConnectorContent.tsx
@@ -8,7 +8,7 @@ function AWSConnector() {
 			<div className="space-y-1">
 				<p className="text-text-sm text-theme-text-secondary">
 					Create a AWS service connector using the IAM Method{" "}
-					<LearnMoreLink href="https://docs.zenml.io/stacks-and-components/auth-management/aws-service-connector#aws-iam-role" />
+					<LearnMoreLink href="https://docs.zenml.io/how-to/auth-management/aws-service-connector#aws-iam-role" />
 				</p>
 				<Codesnippet
 					wrap
@@ -26,7 +26,7 @@ function GCPConnector() {
 			<div className="space-y-1">
 				<p className="text-text-sm text-theme-text-secondary">
 					Create a GCP service connector using the Service Account Method{" "}
-					<LearnMoreLink href="https://docs.zenml.io/stacks-and-components/auth-management/gcp-service-connector#gcp-service-account" />
+					<LearnMoreLink href="https://docs.zenml.io/how-to/auth-management/gcp-service-connector#gcp-service-account" />
 				</p>
 				<Codesnippet
 					wrap
@@ -44,7 +44,7 @@ function AzureStore() {
 			<div className="space-y-1">
 				<p className="text-text-sm text-theme-text-secondary">
 					Create an Azure service connector using the Service Principal Method{" "}
-					<LearnMoreLink href="https://docs.zenml.io/stacks-and-components/auth-management/azure-service-connector#azure-service-principal" />
+					<LearnMoreLink href="https://docs.zenml.io/how-to/auth-management/azure-service-connector#azure-service-principal" />
 				</p>
 				<Codesnippet
 					wrap
diff --git a/src/app/settings/repositories/Fragments.tsx b/src/app/settings/repositories/Fragments.tsx
@@ -63,7 +63,7 @@ export function CommandSection() {
 			))}
 			<HelpBox
 				text="Check all the commands and find more about Repositories in our Docs"
-				link="https://docs.zenml.io/user-guide/production-guide/connect-code-repository"
+				link="https://docs.zenml.io/how-to/setting-up-a-project-repository/connect-your-git-repository"
 			/>
 		</section>
 	);
diff --git a/src/app/settings/secrets/Fragments.tsx b/src/app/settings/secrets/Fragments.tsx
@@ -61,7 +61,7 @@ export function Commands() {
 			))}
 			<HelpBox
 				text="Check all the commands and find more about Secrets in our Docs"
-				link="https://docs.zenml.io/user-guide/advanced-guide/secret-management"
+				link="https://docs.zenml.io/getting-started/deploying-zenml/manage-the-deployed-services/secret-management"
 			/>
 		</section>
 	);
diff --git a/src/components/artifacts/Visualization.tsx b/src/components/artifacts/Visualization.tsx
@@ -65,7 +65,7 @@ export function Visualization({ artifactVersionId, artifactName }: Visualization
 					<a
 						rel="noopener noreferrer"
 						target="_blank"
-						href="https://docs.zenml.io/stacks-and-components/component-guide/artifact-stores/custom"
+						href="https://docs.zenml.io/stack-components/artifact-stores/custom"
 					>
 						docs
 					</a>
diff --git a/src/contents/components.tsx b/src/contents/components.tsx
@@ -21,7 +21,7 @@ export const OrchestratorSection: ComponentTypeSectionProps = {
 		"orchestrator",
 		"ORCHESTRATOR"
 	),
-	helpLink: "https://docs.zenml.io/stacks-and-components/component-guide/orchestrators",
+	helpLink: "https://docs.zenml.io/stack-components/orchestrators",
 	description:
 		"An orchestrator is a special kind of backend that manages the running of each step of the pipeline. Orchestrators administer the actual pipeline runs. By default, ZenML initializes your repository with an orchestrator that runs everything on your local machine."
 };
@@ -33,7 +33,7 @@ export const ArtifactStoreSection: ComponentTypeSectionProps = {
 		"artifact-store",
 		"ARTIFACT_STORE"
 	),
-	helpLink: "https://docs.zenml.io/stacks-and-components/component-guide/artifact-stores",
+	helpLink: "https://docs.zenml.io/stack-components/artifact-stores",
 	description:
 		"The Artifact Store is a central component in any MLOps stack. As the name suggests, it acts as a data persistence layer where artifacts (e.g. datasets, models) ingested or generated by the machine learning pipelines are stored."
 };
@@ -45,7 +45,7 @@ export const ContainerRegistrySection: ComponentTypeSectionProps = {
 		"container-registry",
 		"CONTAINER_REGISTRY"
 	),
-	helpLink: "https://docs.zenml.io/stacks-and-components/component-guide/container-registries",
+	helpLink: "https://docs.zenml.io/stack-components/container-registries",
 	description:
 		"Container registry is used to store container images that are built to run machine learning pipelines in remote environments. Containerization of the pipeline code creates a portable environment that allows code to run in an isolated manner."
 };
@@ -59,7 +59,7 @@ export const StepOperatorSection: ComponentTypeSectionProps = {
 	),
 	description:
 		"Step operators allow you to run individual steps in a custom environment different from the default one used by your active orchestrator.",
-	helpLink: "https://docs.zenml.io/stacks-and-components/component-guide/step-operators"
+	helpLink: "https://docs.zenml.io/stack-components/step-operators"
 };
 
 export const ModelDeployerSection: ComponentTypeSectionProps = {
@@ -71,7 +71,7 @@ export const ModelDeployerSection: ComponentTypeSectionProps = {
 	),
 	description:
 		"Model deployers are stack components responsible for online model serving. They are responsible for deploying models to a remote server. Model deployers also act as a registry for models that are served with ZenML.",
-	helpLink: "https://docs.zenml.io/stacks-and-components/component-guide/model-deployers"
+	helpLink: "https://docs.zenml.io/stack-components/model-deployers"
 };
 
 export const FeatureStoreSection: ComponentTypeSectionProps = {
@@ -83,7 +83,7 @@ export const FeatureStoreSection: ComponentTypeSectionProps = {
 	),
 	description:
 		"ZenML supports connecting to a Redis-backed Feast feature store as a stack component integration.",
-	helpLink: "https://docs.zenml.io/stacks-and-components/component-guide/feature-stores"
+	helpLink: "https://docs.zenml.io/stack-components/feature-stores"
 };
 
 export const ExperimentTrackerSection: ComponentTypeSectionProps = {
@@ -95,21 +95,21 @@ export const ExperimentTrackerSection: ComponentTypeSectionProps = {
 	),
 	description:
 		"Experiment trackers let you track your ML experiments by logging the parameters and allowing you to compare between different runs.",
-	helpLink: "https://docs.zenml.io/stacks-and-components/component-guide/experiment-trackers"
+	helpLink: "https://docs.zenml.io/stack-components/experiment-trackers"
 };
 
 export const AlerterSection: ComponentTypeSectionProps = {
 	commandList: getComponentCommands("alerter", "alerters", "alerter", "ALERTER"),
 	description:
 		"Alerters allow you to send messages to chat services (like Slack, Discord, Mattermost, etc.) from within your pipelines. This is useful to immediately get notified when failures happen, for general monitoring/reporting, and also for building human-in-the-loop ML.",
-	helpLink: "https://docs.zenml.io/stacks-and-components/component-guide/alerters	"
+	helpLink: "https://docs.zenml.io/stack-components/alerters	"
 };
 
 export const AnnotatorSection: ComponentTypeSectionProps = {
 	commandList: getComponentCommands("annotator", "annotators", "annotator", "ANNOTATOR"),
 	description:
 		"Annotators are a stack component that enables the use of data annotation as part of your ZenML stack and pipelines.",
-	helpLink: "https://docs.zenml.io/stacks-and-components/component-guide/annotators"
+	helpLink: "https://docs.zenml.io/stack-components/annotators"
 };
 
 export const DataValidatorSection: ComponentTypeSectionProps = {
@@ -121,7 +121,7 @@ export const DataValidatorSection: ComponentTypeSectionProps = {
 	),
 	description:
 		"Data Validators used in ZenML pipelines usually generate data profiles and data quality check reports that are versioned and stored in the Artifact Store and can be retrieved and visualized later.",
-	helpLink: "https://docs.zenml.io/stacks-and-components/component-guide/data-validators"
+	helpLink: "https://docs.zenml.io/stack-components/data-validators"
 };
 
 export const ImageBuilderSection: ComponentTypeSectionProps = {
@@ -133,7 +133,7 @@ export const ImageBuilderSection: ComponentTypeSectionProps = {
 	),
 	description:
 		"The image builder is an essential part of most remote MLOps stacks. It is used to build container images such that your machine-learning pipelines and steps can be executed in remote environments.",
-	helpLink: "https://docs.zenml.io/stacks-and-components/component-guide/image-builders"
+	helpLink: "https://docs.zenml.io/stack-components/image-builders"
 };
 
 export const ModelRegistrySection: ComponentTypeSectionProps = {
@@ -145,7 +145,7 @@ export const ModelRegistrySection: ComponentTypeSectionProps = {
 	),
 	description:
 		"Model registries are centralized storage solutions for managing and tracking machine learning models across various stages of development and deployment.",
-	helpLink: "https://docs.zenml.io/stacks-and-components/component-guide/model-registries"
+	helpLink: "https://docs.zenml.io/stack-components/model-registries"
 };
 
 export function getComponentCommands(
diff --git a/src/contents/connectors.tsx b/src/contents/connectors.tsx
@@ -37,7 +37,7 @@ export const ConnectorSelectOptions: { label: string; value: ConnectorType; icon
 
 export const KubernetesSection: ConnectorTypeSectionProps = {
 	help: {
-		href: "https://docs.zenml.io/stacks-and-components/auth-management/kubernetes-service-connector",
+		href: "https://docs.zenml.io/how-to/auth-management/kubernetes-service-connector",
 		text: "Use the complete guide to set up your Kubernetes Service Connector."
 	},
 	prerequisites: getPrerequites("kubernetes", "Kubernetes"),
@@ -51,7 +51,7 @@ export const KubernetesSection: ConnectorTypeSectionProps = {
 export const GCPSection: ConnectorTypeSectionProps = {
 	help: {
 		text: "Use the complete guide to set up your GCP Service Connector.",
-		href: "https://docs.zenml.io/stacks-and-components/auth-management/gcp-service-connector"
+		href: "https://docs.zenml.io/how-to/auth-management/gcp-service-connector"
 	},
 	prerequisites: getPrerequites("gcp", "GCP"),
 	listCommand: getListCommand("gcp", "GCP"),
@@ -64,7 +64,7 @@ export const GCPSection: ConnectorTypeSectionProps = {
 export const DockerSection: ConnectorTypeSectionProps = {
 	help: {
 		text: "Use the complete guide to set up your Docker Service Connector.",
-		href: "https://docs.zenml.io/stacks-and-components/auth-management/docker-service-connector"
+		href: "https://docs.zenml.io/how-to/auth-management/docker-service-connector"
 	},
 	listCommand: getListCommand("docker", "Docker"),
 	topInfobox:
@@ -76,7 +76,7 @@ export const DockerSection: ConnectorTypeSectionProps = {
 export const AzureSection: ConnectorTypeSectionProps = {
 	help: {
 		text: "Use the complete guide to set up your Azure Service Connector.",
-		href: "https://docs.zenml.io/stacks-and-components/auth-management/azure-service-connector"
+		href: "https://docs.zenml.io/how-to/auth-management/azure-service-connector"
 	},
 	listCommand: getListCommand("azure", "Azure"),
 	prerequisites: getPrerequites("azure", "Azure"),
@@ -89,7 +89,7 @@ export const AzureSection: ConnectorTypeSectionProps = {
 export const AWSSection: ConnectorTypeSectionProps = {
 	help: {
 		text: "Use the complete guide to set up your AWS Service Connector.",
-		href: "https://docs.zenml.io/stacks-and-components/auth-management/aws-service-connector"
+		href: "https://docs.zenml.io/how-to/auth-management/aws-service-connector"
 	},
 	listCommand: getListCommand("aws", "AWS"),
 	prerequisites: getPrerequites("aws", "AWS"),

Original file line number	Diff line number	Diff line change
`@@ -219,7 +219,7 @@ const ArtifactVisualization = ({`
`219`	`219`	`<a`
`220`	`220`	`rel="noopener noreferrer"`
`221`	`221`	`target="_blank"`
`222`		`- href="https://docs.zenml.io/stacks-and-components/component-guide/artifact-stores/custom"`
	`222`	`+ href="https://docs.zenml.io/stack-components/artifact-stores/custom"`
`223`	`223`	`>`
`224`	`224`	`docs`
`225`	`225`	`</a>`
Original file line number	Diff line number	Diff line change
`@@ -91,7 +91,7 @@ const UserEmail: React.FC = () => {`
`91`	`91`	`<InnerTextLink`
`92`	`92`	`text={'Click Here'}`
`93`	`93`	`href={`
`94`		`- 'https://docs.zenml.io/user-guide/advanced-guide/environment-management/global-settings-of-zenml#usage-analytics'`
	`94`	`+ 'https://docs.zenml.io/reference/global-settings#usage-analytics'`
`95`	`95`	`}`
`96`	`96`	`/>`
`97`	`97`	` {translate('subtitle2-2')}`
Original file line number	Diff line number	Diff line change
`@@ -76,7 +76,7 @@ const HeaderWithButtons: React.FC<{`
`76`	`76`	`<a`
`77`	`77`	`target="_blank"`
`78`	`78`	`rel="noopener noreferrer"`
`79`		`- href="https://docs.zenml.io/stacks-and-components/stack-deployment"`
	`79`	`+ href="https://docs.zenml.io/how-to/stack-deployment"`
`80`	`80`	`>`
`81`	`81`	`deploy a MLOps stack`
`82`	`82`	`</a>{' '}`
Original file line number	Diff line number	Diff line change
`@@ -182,7 +182,7 @@ function OtherStore() {`
`182`	`182`	`emphasis: "subtle",`
`183`	`183`	`size: "md"`
`184`	`184`	`})}`
`185`		`- href="https://docs.zenml.io/stacks-and-components/custom-stack-solutions/implement-a-custom-stack-component"`
	`185`	`+ href="https://docs.zenml.io/how-to/stack-deployment/implement-a-custom-stack-component"`
`186`	`186`	`>`
`187`	`187`	`How to create a custom artifact store`
`188`	`188`	`</a>`