From 8185bf2044a1cf1b1575100d5301de33a13d3206 Mon Sep 17 00:00:00 2001 From: Jeff Hale Date: Tue, 4 Feb 2025 13:58:56 -0500 Subject: [PATCH 01/13] update for docs.json --- .github/pull_request_template.md | 2 +- docs/docs.json | 1584 +++++++++++++++++++ docs/mint.json | 1423 ----------------- docs/overrides/main.html | 21 + docs/v3/api-ref/rest-api/server/schema.json | 2 +- scripts/generate_mintlify_openapi_docs.py | 53 +- 6 files changed, 1632 insertions(+), 1453 deletions(-) create mode 100644 docs/docs.json delete mode 100644 docs/mint.json create mode 100644 docs/overrides/main.html diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index aa359a0fd694..3e4fbd98083b 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -11,5 +11,5 @@ If this is your first contribution, please make sure to review our contribution - [ ] This pull request references any related issue by including "closes ``" - If no issue exists and your change is not a small fix, please [create an issue](https://github.com/PrefectHQ/prefect/issues/new/choose) first. - [ ] If this pull request adds new functionality, it includes unit tests that cover the changes -- [ ] If this pull request removes docs files, it includes redirect settings in `mint.json`. +- [ ] If this pull request removes docs files, it includes redirect settings in `docs.json`. - [ ] If this pull request adds functions or classes, it includes helpful docstrings. diff --git a/docs/docs.json b/docs/docs.json new file mode 100644 index 000000000000..03465be68741 --- /dev/null +++ b/docs/docs.json @@ -0,0 +1,1584 @@ +{ + "$schema": "https://mintlify.com/docs.json", + "theme": "mint", + "name": "Prefect", + "colors": { + "primary": "#2D6DF6", + "light": "#5F92FF", + "dark": "#2D6DF6" + }, + "favicon": "/logos/favicon.png", + "navigation": { + "versions": [ + { + "version": "v3", + "tabs": [ + { + "tab": "Documentation", + "groups": [ + { + "group": "Get started", + "pages": [ + "v3/get-started/index", + "v3/get-started/install", + "v3/get-started/whats-new-prefect-3", + "v3/get-started/quickstart" + ] + }, + { + "group": "Tutorials", + "pages": [ + { + "group": "For data engineers", + "pages": [ + "v3/tutorials/schedule", + "v3/tutorials/pipelines", + "v3/tutorials/scraping", + "v3/tutorials/ml" + ] + }, + { + "group": "For platform engineers", + "pages": [ + "v3/tutorials/platform", + "v3/tutorials/debug", + "v3/tutorials/alerts" + ] + } + ] + }, + { + "group": "Develop", + "pages": [ + "v3/develop/index", + { + "group": "Write and run workflows", + "pages": [ + "v3/develop/write-flows", + "v3/develop/write-tasks", + "v3/develop/deferred-tasks", + "v3/develop/visualize-flow-structure", + "v3/develop/big-data", + "v3/develop/cli-shell", + "v3/develop/secrets" + ] + }, + { + "group": "Configure runtime behavior", + "pages": [ + "v3/develop/logging", + "v3/develop/task-caching", + "v3/develop/transactions", + "v3/develop/pause-resume", + "v3/develop/cancel", + "v3/develop/inputs", + "v3/develop/runtime-context" + ] + }, + { + "group": "Manage state and configuration", + "pages": [ + "v3/develop/manage-states", + "v3/develop/results", + "v3/develop/artifacts", + "v3/develop/variables", + "v3/develop/blocks" + ] + }, + { + "group": "Manage concurrency", + "pages": [ + "v3/develop/task-runners", + "v3/develop/task-run-limits", + "v3/develop/global-concurrency-limits" + ] + }, + { + "group": "Manage settings", + "pages": [ + "v3/develop/settings-and-profiles", + "v3/develop/settings-ref" + ] + }, + "v3/develop/interact-with-api", + "v3/develop/test-workflows" + ] + }, + { + "group": "Deploy", + "pages": [ + "v3/deploy/index", + "v3/deploy/run-flows-in-local-processes", + { + "group": "Run flows on dynamic infrastructure", + "pages": [ + "v3/deploy/infrastructure-concepts/work-pools", + "v3/deploy/infrastructure-concepts/workers", + "v3/deploy/infrastructure-concepts/store-flow-code", + "v3/deploy/infrastructure-concepts/deploy-via-python", + "v3/deploy/infrastructure-concepts/prefect-yaml", + "v3/deploy/infrastructure-concepts/deploy-ci-cd", + "v3/deploy/infrastructure-concepts/customize" + ] + }, + { + "group": "Dynamic infrastructure examples", + "pages": [ + "v3/deploy/infrastructure-examples/managed", + "v3/deploy/infrastructure-examples/serverless", + "v3/deploy/infrastructure-examples/docker", + "v3/deploy/infrastructure-examples/kubernetes", + "v3/deploy/infrastructure-examples/coiled" + ] + }, + { + "group": "Static infrastructure examples", + "pages": [ + "v3/deploy/static-infrastructure-examples/docker" + ] + }, + "v3/deploy/daemonize-processes" + ] + }, + { + "group": "Automate", + "pages": [ + "v3/automate/index", + "v3/automate/add-schedules", + "v3/automate/events/events", + "v3/automate/events/automations-triggers", + "v3/automate/events/custom-triggers", + "v3/automate/events/webhook-triggers", + "v3/automate/events/slas" + ] + }, + { + "group": "Operate", + "pages": [ + "v3/manage/index", + { + "group": "Prefect Cloud", + "pages": [ + "v3/manage/cloud/index", + "v3/manage/cloud/connect-to-cloud", + "v3/manage/cloud/workspaces", + { + "group": "Manage accounts", + "pages": [ + "v3/manage/cloud/manage-users/index", + "v3/manage/cloud/manage-users/service-accounts", + "v3/manage/cloud/manage-users/manage-teams", + "v3/manage/cloud/manage-users/manage-roles", + "v3/manage/cloud/manage-users/api-keys", + "v3/manage/cloud/manage-users/configure-sso", + "v3/manage/cloud/manage-users/audit-logs", + "v3/manage/cloud/manage-users/object-access-control-lists", + "v3/manage/cloud/manage-users/secure-access-by-ip-address" + ] + }, + "v3/manage/cloud/rate-limits", + "v3/manage/cloud/terraform-provider", + "v3/manage/cloud/troubleshoot-cloud" + ] + }, + "v3/manage/self-host" + ] + }, + { + "group": "Migrate", + "pages": [ + "v3/resources/upgrade-to-prefect-3", + "v3/resources/upgrade-agents-to-workers" + ] + } + ] + }, + { + "tab": "APIs & SDK", + "groups": [ + { + "group": "APIs & SDK", + "pages": [ + "v3/api-ref/index", + "v3/api-ref/python/index", + { + "group": "REST API", + "pages": [ + "v3/api-ref/rest-api/index", + { + "group": "Cloud API", + "pages": [ + "v3/api-ref/rest-api/cloud/index" + ] + }, + { + "group": "Server API", + "pages": [ + "v3/api-ref/rest-api/server/index", + { + "group": "Root", + "pages": [ + "v3/api-ref/rest-api/server/root/health-check", + "v3/api-ref/rest-api/server/root/server-version", + "v3/api-ref/rest-api/server/root/hello", + "v3/api-ref/rest-api/server/root/perform-readiness-check" + ] + }, + { + "group": "Flows", + "pages": [ + "v3/api-ref/rest-api/server/flows/create-flow", + "v3/api-ref/rest-api/server/flows/read-flow", + "v3/api-ref/rest-api/server/flows/delete-flow", + "v3/api-ref/rest-api/server/flows/update-flow", + "v3/api-ref/rest-api/server/flows/count-flows", + "v3/api-ref/rest-api/server/flows/read-flow-by-name", + "v3/api-ref/rest-api/server/flows/read-flows", + "v3/api-ref/rest-api/server/flows/paginate-flows", + "v3/api-ref/rest-api/server/flows/count-deployments-by-flow", + "v3/api-ref/rest-api/server/flows/next-runs-by-flow" + ] + }, + { + "group": "Flow Runs", + "pages": [ + "v3/api-ref/rest-api/server/flow-runs/create-flow-run", + "v3/api-ref/rest-api/server/flow-runs/read-flow-run", + "v3/api-ref/rest-api/server/flow-runs/delete-flow-run", + "v3/api-ref/rest-api/server/flow-runs/update-flow-run", + "v3/api-ref/rest-api/server/flow-runs/count-flow-runs", + "v3/api-ref/rest-api/server/flow-runs/average-flow-run-lateness", + "v3/api-ref/rest-api/server/flow-runs/flow-run-history", + "v3/api-ref/rest-api/server/flow-runs/read-flow-run-graph-v1", + "v3/api-ref/rest-api/server/flow-runs/read-flow-run-graph-v2", + "v3/api-ref/rest-api/server/flow-runs/resume-flow-run", + "v3/api-ref/rest-api/server/flow-runs/read-flow-runs", + "v3/api-ref/rest-api/server/flow-runs/set-flow-run-state", + "v3/api-ref/rest-api/server/flow-runs/create-flow-run-input", + "v3/api-ref/rest-api/server/flow-runs/filter-flow-run-input", + "v3/api-ref/rest-api/server/flow-runs/read-flow-run-input", + "v3/api-ref/rest-api/server/flow-runs/delete-flow-run-input", + "v3/api-ref/rest-api/server/flow-runs/paginate-flow-runs", + "v3/api-ref/rest-api/server/flow-runs/download-logs", + "v3/api-ref/rest-api/server/flow-runs/update-flow-run-labels", + "v3/api-ref/rest-api/server/flow-runs/read-flow-run-history", + "v3/api-ref/rest-api/server/flow-runs/count-task-runs-by-flow-run" + ] + }, + { + "group": "Task Runs", + "pages": [ + "v3/api-ref/rest-api/server/task-runs/create-task-run", + "v3/api-ref/rest-api/server/task-runs/read-task-run", + "v3/api-ref/rest-api/server/task-runs/delete-task-run", + "v3/api-ref/rest-api/server/task-runs/update-task-run", + "v3/api-ref/rest-api/server/task-runs/count-task-runs", + "v3/api-ref/rest-api/server/task-runs/task-run-history", + "v3/api-ref/rest-api/server/task-runs/read-task-runs", + "v3/api-ref/rest-api/server/task-runs/set-task-run-state", + "v3/api-ref/rest-api/server/task-runs/read-dashboard-task-run-counts", + "v3/api-ref/rest-api/server/task-runs/read-task-run-counts-by-state" + ] + }, + { + "group": "Flow Run States", + "pages": [ + "v3/api-ref/rest-api/server/flow-run-states/read-flow-run-state", + "v3/api-ref/rest-api/server/flow-run-states/read-flow-run-states" + ] + }, + { + "group": "Task Run States", + "pages": [ + "v3/api-ref/rest-api/server/task-run-states/read-task-run-state", + "v3/api-ref/rest-api/server/task-run-states/read-task-run-states" + ] + }, + { + "group": "Flow Run Notification Policies", + "pages": [ + "v3/api-ref/rest-api/server/flow-run-notification-policies/create-flow-run-notification-policy", + "v3/api-ref/rest-api/server/flow-run-notification-policies/read-flow-run-notification-policy", + "v3/api-ref/rest-api/server/flow-run-notification-policies/delete-flow-run-notification-policy", + "v3/api-ref/rest-api/server/flow-run-notification-policies/update-flow-run-notification-policy", + "v3/api-ref/rest-api/server/flow-run-notification-policies/read-flow-run-notification-policies" + ] + }, + { + "group": "Deployments", + "pages": [ + "v3/api-ref/rest-api/server/deployments/create-deployment", + "v3/api-ref/rest-api/server/deployments/read-deployment", + "v3/api-ref/rest-api/server/deployments/delete-deployment", + "v3/api-ref/rest-api/server/deployments/update-deployment", + "v3/api-ref/rest-api/server/deployments/read-deployment-by-name", + "v3/api-ref/rest-api/server/deployments/read-deployments", + "v3/api-ref/rest-api/server/deployments/paginate-deployments", + "v3/api-ref/rest-api/server/deployments/get-scheduled-flow-runs-for-deployments", + "v3/api-ref/rest-api/server/deployments/count-deployments", + "v3/api-ref/rest-api/server/deployments/schedule-deployment", + "v3/api-ref/rest-api/server/deployments/resume-deployment", + "v3/api-ref/rest-api/server/deployments/pause-deployment", + "v3/api-ref/rest-api/server/deployments/create-flow-run-from-deployment", + "v3/api-ref/rest-api/server/deployments/work-queue-check-for-deployment", + "v3/api-ref/rest-api/server/deployments/read-deployment-schedules", + "v3/api-ref/rest-api/server/deployments/create-deployment-schedules", + "v3/api-ref/rest-api/server/deployments/delete-deployment-schedule", + "v3/api-ref/rest-api/server/deployments/update-deployment-schedule" + ] + }, + { + "group": "SavedSearches", + "pages": [ + "v3/api-ref/rest-api/server/savedsearches/create-saved-search", + "v3/api-ref/rest-api/server/savedsearches/read-saved-search", + "v3/api-ref/rest-api/server/savedsearches/delete-saved-search", + "v3/api-ref/rest-api/server/savedsearches/read-saved-searches" + ] + }, + { + "group": "Logs", + "pages": [ + "v3/api-ref/rest-api/server/logs/create-logs", + "v3/api-ref/rest-api/server/logs/read-logs" + ] + }, + { + "group": "Concurrency Limits", + "pages": [ + "v3/api-ref/rest-api/server/concurrency-limits/create-concurrency-limit", + "v3/api-ref/rest-api/server/concurrency-limits/read-concurrency-limit", + "v3/api-ref/rest-api/server/concurrency-limits/delete-concurrency-limit", + "v3/api-ref/rest-api/server/concurrency-limits/read-concurrency-limit-by-tag", + "v3/api-ref/rest-api/server/concurrency-limits/delete-concurrency-limit-by-tag", + "v3/api-ref/rest-api/server/concurrency-limits/read-concurrency-limits", + "v3/api-ref/rest-api/server/concurrency-limits/reset-concurrency-limit-by-tag", + "v3/api-ref/rest-api/server/concurrency-limits/increment-concurrency-limits-v1", + "v3/api-ref/rest-api/server/concurrency-limits/decrement-concurrency-limits-v1" + ] + }, + { + "group": "Concurrency Limits V2", + "pages": [ + "v3/api-ref/rest-api/server/concurrency-limits-v2/create-concurrency-limit-v2", + "v3/api-ref/rest-api/server/concurrency-limits-v2/read-concurrency-limit-v2", + "v3/api-ref/rest-api/server/concurrency-limits-v2/delete-concurrency-limit-v2", + "v3/api-ref/rest-api/server/concurrency-limits-v2/update-concurrency-limit-v2", + "v3/api-ref/rest-api/server/concurrency-limits-v2/read-all-concurrency-limits-v2", + "v3/api-ref/rest-api/server/concurrency-limits-v2/bulk-increment-active-slots", + "v3/api-ref/rest-api/server/concurrency-limits-v2/bulk-decrement-active-slots" + ] + }, + { + "group": "Block types", + "pages": [ + "v3/api-ref/rest-api/server/block-types/create-block-type", + "v3/api-ref/rest-api/server/block-types/read-block-type-by-id", + "v3/api-ref/rest-api/server/block-types/delete-block-type", + "v3/api-ref/rest-api/server/block-types/update-block-type", + "v3/api-ref/rest-api/server/block-types/read-block-type-by-slug", + "v3/api-ref/rest-api/server/block-types/read-block-types", + "v3/api-ref/rest-api/server/block-types/read-block-documents-for-block-type", + "v3/api-ref/rest-api/server/block-types/read-block-document-by-name-for-block-type", + "v3/api-ref/rest-api/server/block-types/install-system-block-types" + ] + }, + { + "group": "Block documents", + "pages": [ + "v3/api-ref/rest-api/server/block-documents/create-block-document", + "v3/api-ref/rest-api/server/block-documents/read-block-documents", + "v3/api-ref/rest-api/server/block-documents/count-block-documents", + "v3/api-ref/rest-api/server/block-documents/read-block-document-by-id", + "v3/api-ref/rest-api/server/block-documents/delete-block-document", + "v3/api-ref/rest-api/server/block-documents/update-block-document-data" + ] + }, + { + "group": "Work Pools", + "pages": [ + "v3/api-ref/rest-api/server/work-pools/create-work-pool", + "v3/api-ref/rest-api/server/work-pools/read-work-pool", + "v3/api-ref/rest-api/server/work-pools/delete-work-pool", + "v3/api-ref/rest-api/server/work-pools/update-work-pool", + "v3/api-ref/rest-api/server/work-pools/read-work-pools", + "v3/api-ref/rest-api/server/work-pools/count-work-pools", + "v3/api-ref/rest-api/server/work-pools/get-scheduled-flow-runs", + "v3/api-ref/rest-api/server/work-pools/create-work-queue", + "v3/api-ref/rest-api/server/work-pools/read-work-queue", + "v3/api-ref/rest-api/server/work-pools/delete-work-queue", + "v3/api-ref/rest-api/server/work-pools/update-work-queue", + "v3/api-ref/rest-api/server/work-pools/read-work-queues", + "v3/api-ref/rest-api/server/work-pools/worker-heartbeat", + "v3/api-ref/rest-api/server/work-pools/read-workers", + "v3/api-ref/rest-api/server/work-pools/delete-worker" + ] + }, + { + "group": "Task Workers", + "pages": [ + "v3/api-ref/rest-api/server/task-workers/read-task-workers" + ] + }, + { + "group": "Work Queues", + "pages": [ + "v3/api-ref/rest-api/server/work-queues/create-work-queue", + "v3/api-ref/rest-api/server/work-queues/read-work-queue", + "v3/api-ref/rest-api/server/work-queues/delete-work-queue", + "v3/api-ref/rest-api/server/work-queues/update-work-queue", + "v3/api-ref/rest-api/server/work-queues/read-work-queue-by-name", + "v3/api-ref/rest-api/server/work-queues/read-work-queue-runs", + "v3/api-ref/rest-api/server/work-queues/read-work-queues", + "v3/api-ref/rest-api/server/work-queues/read-work-queue-status" + ] + }, + { + "group": "Artifacts", + "pages": [ + "v3/api-ref/rest-api/server/artifacts/create-artifact", + "v3/api-ref/rest-api/server/artifacts/read-artifact", + "v3/api-ref/rest-api/server/artifacts/delete-artifact", + "v3/api-ref/rest-api/server/artifacts/update-artifact", + "v3/api-ref/rest-api/server/artifacts/read-latest-artifact", + "v3/api-ref/rest-api/server/artifacts/read-artifacts", + "v3/api-ref/rest-api/server/artifacts/read-latest-artifacts", + "v3/api-ref/rest-api/server/artifacts/count-artifacts", + "v3/api-ref/rest-api/server/artifacts/count-latest-artifacts" + ] + }, + { + "group": "Block schemas", + "pages": [ + "v3/api-ref/rest-api/server/block-schemas/create-block-schema", + "v3/api-ref/rest-api/server/block-schemas/read-block-schema-by-id", + "v3/api-ref/rest-api/server/block-schemas/delete-block-schema", + "v3/api-ref/rest-api/server/block-schemas/read-block-schemas", + "v3/api-ref/rest-api/server/block-schemas/read-block-schema-by-checksum" + ] + }, + { + "group": "Block capabilities", + "pages": [ + "v3/api-ref/rest-api/server/block-capabilities/read-available-block-capabilities" + ] + }, + { + "group": "Collections", + "pages": [ + "v3/api-ref/rest-api/server/collections/read-view-content" + ] + }, + { + "group": "Variables", + "pages": [ + "v3/api-ref/rest-api/server/variables/create-variable", + "v3/api-ref/rest-api/server/variables/read-variable", + "v3/api-ref/rest-api/server/variables/delete-variable", + "v3/api-ref/rest-api/server/variables/update-variable", + "v3/api-ref/rest-api/server/variables/read-variable-by-name", + "v3/api-ref/rest-api/server/variables/delete-variable-by-name", + "v3/api-ref/rest-api/server/variables/update-variable-by-name", + "v3/api-ref/rest-api/server/variables/read-variables", + "v3/api-ref/rest-api/server/variables/count-variables" + ] + }, + "v3/api-ref/rest-api/server/create-csrf-token", + { + "group": "Events", + "pages": [ + "v3/api-ref/rest-api/server/events/create-events", + "v3/api-ref/rest-api/server/events/read-events", + "v3/api-ref/rest-api/server/events/read-account-events-page", + "v3/api-ref/rest-api/server/events/count-account-events" + ] + }, + { + "group": "Automations", + "pages": [ + "v3/api-ref/rest-api/server/automations/create-automation", + "v3/api-ref/rest-api/server/automations/read-automation", + "v3/api-ref/rest-api/server/automations/update-automation", + "v3/api-ref/rest-api/server/automations/delete-automation", + "v3/api-ref/rest-api/server/automations/patch-automation", + "v3/api-ref/rest-api/server/automations/read-automations", + "v3/api-ref/rest-api/server/automations/count-automations", + "v3/api-ref/rest-api/server/automations/read-automations-related-to-resource", + "v3/api-ref/rest-api/server/automations/delete-automations-owned-by-resource", + "v3/api-ref/rest-api/server/automations/validate-template" + ] + }, + { + "group": "UI", + "pages": [ + "v3/api-ref/rest-api/server/ui/validate-obj" + ] + }, + { + "group": "Admin", + "pages": [ + "v3/api-ref/rest-api/server/admin/read-settings", + "v3/api-ref/rest-api/server/admin/read-version", + "v3/api-ref/rest-api/server/admin/clear-database", + "v3/api-ref/rest-api/server/admin/drop-database", + "v3/api-ref/rest-api/server/admin/create-database" + ] + } + ] + } + ] + } + ] + } + ] + }, + { + "tab": "Integrations", + "groups": [ + { + "group": "Integrations", + "pages": [ + "integrations/integrations", + "integrations/use-integrations", + { + "group": "AWS", + "pages": [ + "integrations/prefect-aws/index", + "integrations/prefect-aws/ecs_guide", + "integrations/prefect-aws/sdk" + ] + }, + { + "group": "Azure", + "pages": [ + "integrations/prefect-azure/index", + "integrations/prefect-azure/aci_worker", + "integrations/prefect-azure/sdk" + ] + }, + { + "group": "Bitbucket", + "pages": [ + "integrations/prefect-bitbucket/index", + "integrations/prefect-bitbucket/sdk" + ] + }, + { + "group": "Dask", + "pages": [ + "integrations/prefect-dask/index", + "integrations/prefect-dask/sdk" + ] + }, + { + "group": "Databricks", + "pages": [ + "integrations/prefect-databricks/index", + "integrations/prefect-databricks/sdk" + ] + }, + { + "group": "dbt", + "pages": [ + "integrations/prefect-dbt/index", + "integrations/prefect-dbt/sdk" + ] + }, + { + "group": "Docker", + "pages": [ + "integrations/prefect-docker/index", + "integrations/prefect-docker/sdk" + ] + }, + { + "group": "Email", + "pages": [ + "integrations/prefect-email/index", + "integrations/prefect-email/sdk" + ] + }, + { + "group": "GCP", + "pages": [ + "integrations/prefect-gcp/index", + "integrations/prefect-gcp/gcp-worker-guide", + "integrations/prefect-gcp/sdk" + ] + }, + { + "group": "GitHub", + "pages": [ + "integrations/prefect-github/index", + "integrations/prefect-github/sdk" + ] + }, + { + "group": "Gitlab", + "pages": [ + "integrations/prefect-gitlab/index", + "integrations/prefect-gitlab/sdk" + ] + }, + { + "group": "Kubernetes", + "pages": [ + "integrations/prefect-kubernetes/index", + "integrations/prefect-kubernetes/sdk" + ] + }, + { + "group": "Ray", + "pages": [ + "integrations/prefect-ray/index", + "integrations/prefect-ray/sdk" + ] + }, + { + "group": "Redis", + "pages": [ + "integrations/prefect-redis/index", + "integrations/prefect-redis/sdk" + ] + }, + { + "group": "Shell", + "pages": [ + "integrations/prefect-shell/index", + "integrations/prefect-shell/sdk" + ] + }, + { + "group": "Slack", + "pages": [ + "integrations/prefect-slack/index", + "integrations/prefect-slack/sdk" + ] + }, + { + "group": "Snowflake", + "pages": [ + "integrations/prefect-snowflake/index", + "integrations/prefect-snowflake/sdk" + ] + }, + { + "group": "SQLAlchemy", + "pages": [ + "integrations/prefect-sqlalchemy/index", + "integrations/prefect-sqlalchemy/sdk" + ] + } + ] + } + ] + }, + { + "tab": "Contribute", + "groups": [ + { + "group": "Contribute", + "pages": [ + "contribute/index", + "contribute/docs-contribute", + "contribute/dev-contribute", + "contribute/contribute-integrations", + "contribute/styles-practices", + "contribute/code-of-conduct" + ] + } + ] + } + ] + }, + { + "version": "v2", + "tabs": [ + { + "tab": "Documentation", + "groups": [ + { + "group": "Get started", + "pages": [ + "v2/get-started/index" + ] + } + ] + }, + { + "tab": "Integrations", + "groups": [ + { + "group": "Integrations", + "pages": [ + "integrations/integrations", + "integrations/use-integrations", + { + "group": "AWS", + "pages": [ + "integrations/prefect-aws/index", + "integrations/prefect-aws/ecs_guide", + "integrations/prefect-aws/sdk" + ] + }, + { + "group": "Azure", + "pages": [ + "integrations/prefect-azure/index", + "integrations/prefect-azure/aci_worker", + "integrations/prefect-azure/sdk" + ] + }, + { + "group": "Bitbucket", + "pages": [ + "integrations/prefect-bitbucket/index", + "integrations/prefect-bitbucket/sdk" + ] + }, + { + "group": "Dask", + "pages": [ + "integrations/prefect-dask/index", + "integrations/prefect-dask/usage_guide", + "integrations/prefect-dask/sdk" + ] + }, + { + "group": "Databricks", + "pages": [ + "integrations/prefect-databricks/index", + "integrations/prefect-databricks/sdk" + ] + }, + { + "group": "dbt", + "pages": [ + "integrations/prefect-dbt/index", + "integrations/prefect-dbt/sdk" + ] + }, + { + "group": "Docker", + "pages": [ + "integrations/prefect-docker/index", + "integrations/prefect-docker/sdk" + ] + }, + { + "group": "Email", + "pages": [ + "integrations/prefect-email/index", + "integrations/prefect-email/sdk" + ] + }, + { + "group": "GCP", + "pages": [ + "integrations/prefect-gcp/index", + "integrations/prefect-gcp/gcp-worker-guide", + "integrations/prefect-gcp/sdk" + ] + }, + { + "group": "GitHub", + "pages": [ + "integrations/prefect-github/index", + "integrations/prefect-github/sdk" + ] + }, + { + "group": "Gitlab", + "pages": [ + "integrations/prefect-gitlab/index", + "integrations/prefect-gitlab/sdk" + ] + }, + { + "group": "Kubernetes", + "pages": [ + "integrations/prefect-kubernetes/index", + "integrations/prefect-kubernetes/sdk" + ] + }, + { + "group": "Ray", + "pages": [ + "integrations/prefect-ray/index", + "integrations/prefect-ray/sdk" + ] + }, + { + "group": "Redis", + "pages": [ + "integrations/prefect-redis/index", + "integrations/prefect-redis/sdk" + ] + }, + { + "group": "Shell", + "pages": [ + "integrations/prefect-shell/index", + "integrations/prefect-shell/sdk" + ] + }, + { + "group": "Slack", + "pages": [ + "integrations/prefect-slack/index", + "integrations/prefect-slack/sdk" + ] + }, + { + "group": "Snowflake", + "pages": [ + "integrations/prefect-snowflake/index", + "integrations/prefect-snowflake/sdk" + ] + }, + { + "group": "SQLAlchemy", + "pages": [ + "integrations/prefect-sqlalchemy/index", + "integrations/prefect-sqlalchemy/sdk" + ] + } + ] + } + ] + }, + { + "tab": "Contribute", + "groups": [ + { + "group": "Contribute", + "pages": [ + "contribute/index", + "contribute/docs-contribute", + "contribute/dev-contribute", + "contribute/contribute-integrations", + "contribute/styles-practices", + "contribute/code-of-conduct" + ] + } + ] + } + ] + } + ], + "global": { + "anchors": [ + { + "anchor": "GitHub", + "href": "https://github.com/PrefectHQ/prefect", + "icon": "github" + }, + { + "anchor": "Community", + "href": "https://communityinviter.com/apps/prefect-community/prefect-community", + "icon": "slack" + }, + { + "anchor": "Prefect Cloud", + "href": "https://app.prefect.cloud", + "icon": "cloud" + } + ] + } + }, + "styling": { + "rounded": "sharp" + }, + "logo": { + "light": "/logos/logo-word-black.svg", + "dark": "/logos/logo-word-white.svg", + "href": "https://prefect.io" + }, + "api": { + "playground": { + "display": "simple" + } + }, + "appearance": { + "default": "light", + "strict": false + }, + "navbar": { + "primary": { + "type": "github", + "href": "https://github.com/PrefectHQ/Prefect" + } + }, + "footer": { + "socials": { + "github": "https://github.com/PrefectHQ/prefect", + "linkedin": "https://www.linkedin.com/company/prefect/mycompany/", + "slack": "https://communityinviter.com/apps/prefect-community/prefect-community", + "twitter": "https://x.com/prefectio", + "youtube": "https://www.youtube.com/c/PrefectIO" + } + }, + "integrations": { + "ga4": { + "measurementId": "G-8GR5P04T5Y" + } + }, + "redirects": [ + { + "source": "/getting-started/:slug*", + "destination": "/v3/getting-started/:slug*" + }, + { + "source": "/tutorial/:slug*", + "destination": "/v3/tutorial/:slug*" + }, + { + "source": "/guides/:slug*", + "destination": "/v3/guides/:slug*" + }, + { + "source": "/concepts/:slug*", + "destination": "/v3/concepts/:slug*" + }, + { + "source": "/cloud/:slug*", + "destination": "/v3/cloud/:slug*" + }, + { + "source": "/api-ref/:slug*", + "destination": "/v3/api-ref/:slug*" + }, + { + "source": "/latest/tutorial", + "destination": "/v3/get-started" + }, + { + "source": "/latest/getting-started/quickstart", + "destination": "/v3/get-started" + }, + { + "source": "/latest/concepts/flows", + "destination": "/v3/develop/write-flows" + }, + { + "source": "/latest/concepts/deployments", + "destination": "/v3/deploy" + }, + { + "source": "/latest/getting-started/installation", + "destination": "/v3/get-started/install" + }, + { + "source": "/latest/concepts/work-pools", + "destination": "/v3/deploy/infrastructure-concepts/work-pools" + }, + { + "source": "/latest/guides/host", + "destination": "/v3/manage/self-host" + }, + { + "source": "/latest/concepts/tasks", + "destination": "/v3/develop/write-tasks" + }, + { + "source": "/v3/manage/settings-and-profiles", + "destination": "/v3/develop/settings-and-profiles" + }, + { + "source": "/latest/guides", + "destination": "/v3" + }, + { + "source": "/latest/tutorial/deployments", + "destination": "/v3/deploy" + }, + { + "source": "/latest/tutorial/flows", + "destination": "/v3/develop/write-flows" + }, + { + "source": "/latest/concepts", + "destination": "/v3" + }, + { + "source": "/latest/guides/prefect-deploy", + "destination": "/v3/deploy" + }, + { + "source": "/latest/tutorial/tasks", + "destination": "/v3/develop/write-tasks" + }, + { + "source": "/latest/concepts/schedules", + "destination": "/v3/automate/add-schedules" + }, + { + "source": "/latest/guides/docker", + "destination": "/v3/deploy/infrastructure-examples/docker" + }, + { + "source": "/latest/tutorial/work-pools", + "destination": "/v3/deploy/infrastructure-concepts/work-pools" + }, + { + "source": "/latest/guides/settings", + "destination": "/v3/develop/settings-and-profiles" + }, + { + "source": "/latest/concepts/task-runners", + "destination": "/v3/develop/task-runners" + }, + { + "source": "/latest/tutorial/workers", + "destination": "/v3/deploy/infrastructure-concepts/workers" + }, + { + "source": "/latest/cloud", + "destination": "/v3/manage/cloud" + }, + { + "source": "/latest/integrations", + "destination": "/v3/integrations" + }, + { + "source": "/latest/concepts/results", + "destination": "/v3/develop/results" + }, + { + "source": "/latest/concepts/automations", + "destination": "/v3/automate" + }, + { + "source": "/latest/guides/logs", + "destination": "/v3/develop/logging" + }, + { + "source": "/latest/concepts/blocks", + "destination": "/v3/develop/blocks" + }, + { + "source": "/latest/guides/deployment/kubernetes", + "destination": "/v3/deploy/infrastructure-examples/kubernetes" + }, + { + "source": "/latest/concepts/states", + "destination": "/v3/develop/manage-states" + }, + { + "source": "/latest/guides/upgrade-guide-agents-to-workers", + "destination": "/v3/resources/upgrade-agents-to-workers" + }, + { + "source": "/latest/guides/webhooks", + "destination": "/v3/automate/events/webhook-triggers" + }, + { + "source": "/latest/cloud/webhooks", + "destination": "/v3/automate/events/webhook-triggers" + }, + { + "source": "/latest/concepts/artifacts", + "destination": "/v3/develop/artifacts" + }, + { + "source": "/latest/api-ref/rest-api-reference", + "destination": "/v3/api-ref/rest-api" + }, + { + "source": "/latest/guides/global-concurrency-limits", + "destination": "/v3/develop/global-concurrency-limits" + }, + { + "source": "/latest/guides/variables", + "destination": "/v3/develop/variables" + }, + { + "source": "/latest/guides/using-the-client", + "destination": "/v3/api-ref" + }, + { + "source": "/latest/guides/deployment/storage-guide", + "destination": "/v3/deploy/infrastructure-concepts/store-flow-code" + }, + { + "source": "/latest/guides/testing", + "destination": "/v3/develop/test-workflows" + }, + { + "source": "/latest/guides/deployment/push-work-pools", + "destination": "/v3/deploy/infrastructure-examples/serverless" + }, + { + "source": "/latest/guides/creating-interactive-workflows", + "destination": "/v3/develop/inputs" + }, + { + "source": "/latest/guides/dask-ray-task-runners", + "destination": "/integrations/prefect-dask/usage_guide" + }, + { + "source": "/latest/guides/ci-cd", + "destination": "/v3/deploy/infrastructure-concepts/deploy-ci-cd" + }, + { + "source": "/latest/concepts/deployments-block-based", + "destination": "/v3/resources/upgrade-agents-to-workers" + }, + { + "source": "/latest/concepts/infrastructure", + "destination": "/v3/deploy/infrastructure-concepts/work-pools" + }, + { + "source": "/latest/guides/runtime-context", + "destination": "/v3/develop/runtime-context" + }, + { + "source": "/latest/guides/deployment/overriding-job-variables", + "destination": "/v3/deploy/infrastructure-concepts/customize" + }, + { + "source": "/latest/guides/managed-execution", + "destination": "/v3/deploy/infrastructure-examples/managed" + }, + { + "source": "/latest/guides/specifying-upstream-dependencies", + "destination": "/v3/develop/write-flows" + }, + { + "source": "/latest/guides/automations", + "destination": "/v3/automate" + }, + { + "source": "/latest/concepts/agents", + "destination": "/v3/resources/upgrade-agents-to-workers" + }, + { + "source": "/latest/integrations/prefect-aws", + "destination": "/integrations/prefect-aws" + }, + { + "source": "/latest/concepts/storage", + "destination": "/v3/deploy/infrastructure-concepts/store-flow-code" + }, + { + "source": "/latest/guides/deployment/daemonize", + "destination": "/v3/deploy/daemonize-processes" + }, + { + "source": "/latest/cloud/users/api-keys", + "destination": "/v3/manage/cloud/manage-users/api-keys" + }, + { + "source": "/latest/community", + "destination": "/v3/contribute" + }, + { + "source": "/latest/concepts/filesystems", + "destination": "/v3/develop/blocks" + }, + { + "source": "/latest/cloud/events", + "destination": "/v3/events" + }, + { + "source": "/latest/recipes/recipes", + "destination": "/v3" + }, + { + "source": "/latest/guides/cli-shell", + "destination": "/v3/develop/cli-shell" + }, + { + "source": "/latest/api-ref/server", + "destination": "/v3/api-ref/rest-api/server" + }, + { + "source": "/latest/guides/moving-data", + "destination": "/v3/develop/blocks" + }, + { + "source": "/latest/guides/deployment/developing-a-new-worker-type", + "destination": "/contribute/develop-a-new-worker-type" + }, + { + "source": "/latest/guides/state-change-hooks", + "destination": "/v3/develop/manage-states" + }, + { + "source": "/latest/guides/deployment/serverless-workers", + "destination": "/v3/deploy/infrastructure-examples/serverless" + }, + { + "source": "/latest/integrations/usage", + "destination": "/integrations/integrations" + }, + { + "source": "/latest/guides/troubleshooting", + "destination": "/v3/manage/cloud/troubleshoot-cloud" + }, + { + "source": "/latest/guides/big-data", + "destination": "/v3/develop/big-data" + }, + { + "source": "/latest/cloud/workspaces", + "destination": "/v3/manage/cloud/workspaces" + }, + { + "source": "/latest/integrations/prefect-aws/ecs_guide", + "destination": "/integrations/prefect-aws/ecs_guide" + }, + { + "source": "/latest/integrations/prefect-kubernetes", + "destination": "/integrations/prefect-kubernetes" + }, + { + "source": "/latest/faq", + "destination": "/v3/get-started/whats-new-prefect-3" + }, + { + "source": "/latest/guides/migration-guide", + "destination": "/v3/resources/upgrade-to-prefect-3" + }, + { + "source": "/latest/integrations/prefect-dbt", + "destination": "/integrations/prefect-dbt" + }, + { + "source": "/latest/integrations/prefect-aws/ecs_worker", + "destination": "/integrations/prefect-aws/ecs_guide" + }, + { + "source": "/latest/contributing/overview", + "destination": "/v3/contribute" + }, + { + "source": "/latest/guides/secrets", + "destination": "/v3/develop/secrets" + }, + { + "source": "/latest/cloud/connecting", + "destination": "/v3/manage/cloud/connect-to-cloud" + }, + { + "source": "/latest/cloud/users/roles", + "destination": "/v3/manage/cloud/manage-users/manage-roles" + }, + { + "source": "/latest/integrations/prefect-docker", + "destination": "/integrations/prefect-docker" + }, + { + "source": "/latest/cloud/users", + "destination": "/v3/manage/cloud/manage-users" + }, + { + "source": "/v3/integrations/prefect-gcp", + "destination": "/integrations/prefect-gcp" + }, + { + "source": "/latest/cloud/users/sso", + "destination": "/latest/manage/cloud/manage-users/configure-sso" + }, + { + "source": "/latest/integrations/prefect-dask", + "destination": "/integrations/prefect-dask" + }, + { + "source": "/latest/integrations/prefect-gcp/gcp-worker-guide", + "destination": "/integrations/prefect-gcp/gcp-worker-guide" + }, + { + "source": "/latest/cloud/rate-limits", + "destination": "/v3/manage/cloud/rate-limits" + }, + { + "source": "/latest/integrations/prefect-sqlalchemy", + "destination": "/integrations/prefect-sqlalchemy" + }, + { + "source": "/latest/integrations/prefect-slack", + "destination": "/integrations/prefect-slack" + }, + { + "source": "/latest/integrations/prefect-gitlab", + "destination": "/integrations/prefect-gitlab" + }, + { + "source": "/latest/integrations/prefect-dbt/cli/commands", + "destination": "/integrations/prefect-dbt" + }, + { + "source": "/latest/integrations/prefect-databricks", + "destination": "/integrations/prefect-databricks" + }, + { + "source": "/latest/cloud/users/service-accounts", + "destination": "/latest/manage/cloud/manage-users/service-accounts" + }, + { + "source": "/latest/integrations/prefect-shell", + "destination": "/integrations/prefect-shell" + }, + { + "source": "/latest/integrations/prefect-azure", + "destination": "/integrations/prefect-azure" + }, + { + "source": "/latest/guides/deployment/aci", + "destination": "/integrations/prefect-azure/aci_worker#why-use-aci-for-flow-run-execution" + }, + { + "source": "/latest/api-ref/server/api/deployments", + "destination": "/v3/api-ref/python" + }, + { + "source": "/latest/integrations/prefect-github", + "destination": "/integrations/prefect-github" + }, + { + "source": "/latest/integrations/prefect-aws/s3", + "destination": "/integrations/prefect-aws" + }, + { + "source": "/latest/api-ref/server/api/flow_runs", + "destination": "/v3/api-ref" + }, + { + "source": "/latest/cloud/incidents", + "destination": "/latest/automate/incidents" + }, + { + "source": "/latest/integrations/prefect-aws/ecs", + "destination": "/integrations/prefect-aws" + }, + { + "source": "/latest/integrations/prefect-email", + "destination": "/integrations/prefect-email" + }, + { + "source": "/latest/integrations/prefect-snowflake", + "destination": "/integrations/prefect-snowflake" + }, + { + "source": "/latest/integrations/contribute", + "destination": "/contribute/contribute-integrations" + }, + { + "source": "/latest/integrations/prefect-aws/lambda_function", + "destination": "/integrations/prefect-aws" + }, + { + "source": "/latest/integrations/prefect-docker/host", + "destination": "/integrations/prefect-docker" + }, + { + "source": "/latest/integrations/prefect-docker/worker", + "destination": "/integrations/prefect-docker" + }, + { + "source": "/latest/api-ref/server/schemas/schedules", + "destination": "/v3/api-ref/python" + }, + { + "source": "/latest/integrations/prefect-docker/deployments/steps", + "destination": "/integrations/prefect-docker" + }, + { + "source": "/latest/integrations/prefect-ray", + "destination": "/integrations/prefect-ray" + }, + { + "source": "/implementation/azure/aks", + "destination": "/v3/deploy/infrastructure-examples/kubernetes" + }, + { + "source": "/latest/api-ref/server/models/flow_runs", + "destination": "/v3/api-ref/python" + }, + { + "source": "/latest/integrations/prefect-gcp/bigquery", + "destination": "/integrations/prefect-gcp" + }, + { + "source": "/latest/integrations/prefect-sqlalchemy/database", + "destination": "/integrations/prefect-sqlalchemy" + }, + { + "source": "/latest/contributing/versioning", + "destination": "/contribute/styles-practices" + }, + { + "source": "/latest/integrations/prefect-dask/task_runners", + "destination": "/integrations/prefect-dask" + }, + { + "source": "/latest/integrations/prefect-dask/usage_guide", + "destination": "/integrations/prefect-dask" + }, + { + "source": "/latest/integrations/prefect-shell/commands", + "destination": "/integrations/prefect-shell" + }, + { + "source": "/latest/integrations/prefect-azure/aci_worker", + "destination": "/integrations/prefect-azure/aci_worker" + }, + { + "source": "/latest/integrations/prefect-aws/batch", + "destination": "/integrations/prefect-aws" + }, + { + "source": "/latest/integrations/prefect-docker/containers", + "destination": "/integrations/prefect-docker" + }, + { + "source": "/latest/api-ref/server/api/flows", + "destination": "/v3/api-ref/rest-api/server/flows" + }, + { + "source": "/latest/api-ref/server/schemas/filters", + "destination": "/v3/api-ref" + }, + { + "source": "/latest/integrations/prefect-docker/images", + "destination": "/integrations/prefect-docker" + }, + { + "source": "/latest/contributing/style", + "destination": "/contribute/styles-practices" + }, + { + "source": "/latest/integrations/prefect-docker/credentials", + "destination": "/integrations/prefect-docker" + }, + { + "source": "/latest/integrations/prefect-gcp/cloud_storage", + "destination": "/integrations/prefect-gcp" + }, + { + "source": "/latest/api-ref/server/api/admin", + "destination": "/v3/api-ref" + }, + { + "source": "/latest/api-ref/server/api/server", + "destination": "/v3/api-ref" + }, + { + "source": "/latest/cloud/users/object-access-control-lists", + "destination": "/v3/manage/cloud/manage-users/object-access-control-lists" + }, + { + "source": "/latest/integrations/prefect-aws/secrets_manager", + "destination": "/integrations/prefect-aws" + }, + { + "source": "/latest/integrations/prefect-aws/credentials", + "destination": "/integrations/prefect-aws" + }, + { + "source": "/latest/integrations/prefect-databricks/jobs", + "destination": "/integrations/prefect-databricks" + }, + { + "source": "/latest/integrations/prefect-databricks/models/jobs", + "destination": "/integrations/prefect-databricks" + }, + { + "source": "/latest/integrations/prefect-kubernetes/worker", + "destination": "/integrations/prefect-kubernetes" + }, + { + "source": "/latest/integrations/prefect-sqlalchemy/credentials", + "destination": "/integrations/prefect-sqlalchemy" + }, + { + "source": "/latest/integrations/prefect-databricks/flows", + "destination": "/integrations/prefect-databricks" + }, + { + "source": "/latest/integrations/prefect-kubernetes/deployments", + "destination": "/integrations/prefect-kubernetes" + }, + { + "source": "/latest/integrations/prefect-snowflake/credentials", + "destination": "/integrations/prefect-snowflake" + }, + { + "source": "/latest/integrations/prefect-dbt/cli/credentials", + "destination": "/integrations/prefect-dbt" + }, + { + "source": "/latest/integrations/prefect-kubernetes/jobs", + "destination": "/integrations/prefect-kubernetes" + }, + { + "source": "/latest/integrations/prefect-slack/messages", + "destination": "/integrations/prefect-slack" + }, + { + "source": "/v3/resources/whats-new-prefect-3", + "destination": "/v3/get-started/whats-new-prefect-3" + }, + { + "source": "/v3/resources/deferred-tasks", + "destination": "/v3/develop/deferred-tasks" + }, + { + "source": "/v3/resources/visualize-flow-structure", + "destination": "/v3/develop/visualize-flow-structure" + }, + { + "source": "/v3/resources/big-data", + "destination": "/v3/develop/big-data" + }, + { + "source": "/v3/resources/cli-shell", + "destination": "/v3/develop/cli-shell" + }, + { + "source": "/v3/resources/secrets", + "destination": "/v3/develop/secrets" + }, + { + "source": "/v3/resources/cancel", + "destination": "/v3/develop/cancel" + }, + { + "source": "/v3/resources/daemonize-processes", + "destination": "/v3/deploy/daemonize-processes" + }, + { + "source": "/v3/resources/interact-with-api", + "destination": "/v3/develop/interact-with-api" + }, + { + "source": "/latest/api-ref/prefect/:slug*", + "destination": "/v3/api-ref/python" + }, + { + "source": "/api-ref/prefect/:slug*", + "destination": "/v3/api-ref/python" + }, + { + "source": "/3rc/:slug*", + "destination": "/v3/:slug*" + }, + { + "source": "/latest/:slug*", + "destination": "/v3/:slug*" + }, + { + "source": "/3/:slug*", + "destination": "/v3/:slug*" + }, + { + "source": "/3.0/:slug*", + "destination": "/v3/:slug*" + }, + { + "source": "/2/:slug*", + "destination": "/v2/:slug*" + } + ] +} \ No newline at end of file diff --git a/docs/mint.json b/docs/mint.json deleted file mode 100644 index 447045c5a4f6..000000000000 --- a/docs/mint.json +++ /dev/null @@ -1,1423 +0,0 @@ -{ - "$schema": "https://mintlify.com/schema.json", - "rounded": "sharp", - "analytics": { - "ga4": { - "measurementId": "G-8GR5P04T5Y" - } - }, - "anchors": [ - { - "icon": "github", - "name": "GitHub", - "url": "https://github.com/PrefectHQ/prefect" - }, - { - "icon": "slack", - "name": "Community", - "url": "https://communityinviter.com/apps/prefect-community/prefect-community" - }, - { - "icon": "cloud", - "name": "Prefect Cloud", - "url": "https://app.prefect.cloud" - } - ], - "api": { - "playground": { - "mode": "simple" - } - }, - "colors": { - "dark": "#2D6DF6", - "light": "#5F92FF", - "primary": "#2D6DF6" - }, - "favicon": "/logos/favicon.png", - "feedback": { - "thumbsRating": true - }, - "footerSocials": { - "github": "https://github.com/PrefectHQ/prefect", - "linkedin": "https://www.linkedin.com/company/prefect/mycompany/", - "slack": "https://communityinviter.com/apps/prefect-community/prefect-community", - "twitter": "https://x.com/prefectio", - "youtube": "https://www.youtube.com/c/PrefectIO" - }, - "logo": { - "dark": "/logos/logo-word-white.svg", - "light": "/logos/logo-word-black.svg", - "href": "https://prefect.io" - }, - "modeToggle": { - "default": "light", - "isHidden": false - }, - "name": "Prefect", - "navigation": [ - { - "group": "Get started", - "pages": [ - "v3/get-started/index", - "v3/get-started/install", - "v3/get-started/whats-new-prefect-3", - "v3/get-started/quickstart" - ], - "version": "v3" - }, - { - "group": "Tutorials", - "pages": [ - { - "group": "For data engineers", - "pages": [ - "v3/tutorials/schedule", - "v3/tutorials/pipelines", - "v3/tutorials/scraping", - "v3/tutorials/ml" - ] - }, - { - "group": "For platform engineers", - "pages": [ - "v3/tutorials/platform", - "v3/tutorials/debug", - "v3/tutorials/alerts" - ] - } - ], - "version": "v3" - }, - { - "group": "Get started", - "pages": [ - "v2/get-started/index" - ], - "version": "v2" - }, - { - "group": "Develop", - "pages": [ - "v3/develop/index", - { - "group": "Write and run workflows", - "pages": [ - "v3/develop/write-flows", - "v3/develop/write-tasks", - "v3/develop/deferred-tasks", - "v3/develop/visualize-flow-structure", - "v3/develop/big-data", - "v3/develop/cli-shell", - "v3/develop/secrets" - ], - "version": "v3" - }, - { - "group": "Configure runtime behavior", - "pages": [ - "v3/develop/logging", - "v3/develop/task-caching", - "v3/develop/transactions", - "v3/develop/pause-resume", - "v3/develop/cancel", - "v3/develop/inputs", - "v3/develop/runtime-context" - ], - "version": "v3" - }, - { - "group": "Manage state and configuration", - "pages": [ - "v3/develop/manage-states", - "v3/develop/results", - "v3/develop/artifacts", - "v3/develop/variables", - "v3/develop/blocks" - ], - "version": "v3" - }, - { - "group": "Manage concurrency", - "pages": [ - "v3/develop/task-runners", - "v3/develop/task-run-limits", - "v3/develop/global-concurrency-limits" - ], - "version": "v3" - }, - { - "group": "Manage settings", - "pages": [ - "v3/develop/settings-and-profiles", - "v3/develop/settings-ref" - ] - }, - "v3/develop/interact-with-api", - "v3/develop/test-workflows" - ], - "version": "v3" - }, - { - "group": "Deploy", - "pages": [ - "v3/deploy/index", - "v3/deploy/run-flows-in-local-processes", - { - "group": "Run flows on dynamic infrastructure", - "pages": [ - "v3/deploy/infrastructure-concepts/work-pools", - "v3/deploy/infrastructure-concepts/workers", - "v3/deploy/infrastructure-concepts/store-flow-code", - "v3/deploy/infrastructure-concepts/deploy-via-python", - "v3/deploy/infrastructure-concepts/prefect-yaml", - "v3/deploy/infrastructure-concepts/deploy-ci-cd", - "v3/deploy/infrastructure-concepts/customize" - ], - "version": "v3" - }, - { - "group": "Dynamic infrastructure examples", - "pages": [ - "v3/deploy/infrastructure-examples/managed", - "v3/deploy/infrastructure-examples/serverless", - "v3/deploy/infrastructure-examples/docker", - "v3/deploy/infrastructure-examples/kubernetes", - "v3/deploy/infrastructure-examples/coiled" - ], - "version": "v3" - }, - { - "group": "Static infrastructure examples", - "pages": [ - "v3/deploy/static-infrastructure-examples/docker" - ], - "version": "v3" - }, - "v3/deploy/daemonize-processes" - ], - "version": "v3" - }, - { - "group": "Automate", - "pages": [ - "v3/automate/index", - "v3/automate/add-schedules", - "v3/automate/events/events", - "v3/automate/events/automations-triggers", - "v3/automate/events/custom-triggers", - "v3/automate/events/webhook-triggers", - "v3/automate/events/slas" - ], - "version": "v3" - }, - { - "group": "Operate", - "pages": [ - "v3/manage/index", - { - "group": "Prefect Cloud", - "pages": [ - "v3/manage/cloud/index", - "v3/manage/cloud/connect-to-cloud", - "v3/manage/cloud/workspaces", - { - "group": "Manage accounts", - "pages": [ - "v3/manage/cloud/manage-users/index", - "v3/manage/cloud/manage-users/service-accounts", - "v3/manage/cloud/manage-users/manage-teams", - "v3/manage/cloud/manage-users/manage-roles", - "v3/manage/cloud/manage-users/api-keys", - "v3/manage/cloud/manage-users/configure-sso", - "v3/manage/cloud/manage-users/audit-logs", - "v3/manage/cloud/manage-users/object-access-control-lists", - "v3/manage/cloud/manage-users/secure-access-by-ip-address" - ], - "version": "v3" - }, - "v3/manage/cloud/rate-limits", - "v3/manage/cloud/terraform-provider", - "v3/manage/cloud/troubleshoot-cloud" - ], - "version": "v3" - }, - "v3/manage/self-host" - ], - "version": "v3" - }, - { - "group": "Migrate", - "pages": [ - "v3/resources/upgrade-to-prefect-3", - "v3/resources/upgrade-agents-to-workers" - ], - "version": "v3" - }, - { - "group": "Integrations", - "pages": [ - "integrations/integrations", - "integrations/use-integrations", - { - "group": "AWS", - "pages": [ - "integrations/prefect-aws/index", - "integrations/prefect-aws/ecs_guide", - "integrations/prefect-aws/sdk" - ] - }, - { - "group": "Azure", - "pages": [ - "integrations/prefect-azure/index", - "integrations/prefect-azure/aci_worker", - "integrations/prefect-azure/sdk" - ] - }, - { - "group": "Bitbucket", - "pages": [ - "integrations/prefect-bitbucket/index", - "integrations/prefect-bitbucket/sdk" - ] - }, - { - "group": "Dask", - "pages": [ - "integrations/prefect-dask/index", - "integrations/prefect-dask/usage_guide", - "integrations/prefect-dask/sdk" - ] - }, - { - "group": "Databricks", - "pages": [ - "integrations/prefect-databricks/index", - "integrations/prefect-databricks/sdk" - ] - }, - { - "group": "dbt", - "pages": [ - "integrations/prefect-dbt/index", - "integrations/prefect-dbt/sdk" - ] - }, - { - "group": "Docker", - "pages": [ - "integrations/prefect-docker/index", - "integrations/prefect-docker/sdk" - ] - }, - { - "group": "Email", - "pages": [ - "integrations/prefect-email/index", - "integrations/prefect-email/sdk" - ] - }, - { - "group": "GCP", - "pages": [ - "integrations/prefect-gcp/index", - "integrations/prefect-gcp/gcp-worker-guide", - "integrations/prefect-gcp/sdk" - ] - }, - { - "group": "GitHub", - "pages": [ - "integrations/prefect-github/index", - "integrations/prefect-github/sdk" - ] - }, - { - "group": "Gitlab", - "pages": [ - "integrations/prefect-gitlab/index", - "integrations/prefect-gitlab/sdk" - ] - }, - { - "group": "Kubernetes", - "pages": [ - "integrations/prefect-kubernetes/index", - "integrations/prefect-kubernetes/sdk" - ] - }, - { - "group": "Ray", - "pages": [ - "integrations/prefect-ray/index", - "integrations/prefect-ray/sdk" - ] - }, - { - "group": "Redis", - "pages": [ - "integrations/prefect-redis/index", - "integrations/prefect-redis/sdk" - ] - }, - { - "group": "Shell", - "pages": [ - "integrations/prefect-shell/index", - "integrations/prefect-shell/sdk" - ] - }, - { - "group": "Slack", - "pages": [ - "integrations/prefect-slack/index", - "integrations/prefect-slack/sdk" - ] - }, - { - "group": "Snowflake", - "pages": [ - "integrations/prefect-snowflake/index", - "integrations/prefect-snowflake/sdk" - ] - }, - { - "group": "SQLAlchemy", - "pages": [ - "integrations/prefect-sqlalchemy/index", - "integrations/prefect-sqlalchemy/sdk" - ] - } - ] - }, - { - "group": "APIs & SDK", - "pages": [ - "v3/api-ref/index", - "v3/api-ref/python/index", - { - "group": "REST API", - "pages": [ - "v3/api-ref/rest-api/index", - { - "group": "Cloud API", - "pages": [ - "v3/api-ref/rest-api/cloud/index" - ], - "version": "v3" - }, - { - "group": "Server API", - "pages": [ - "v3/api-ref/rest-api/server/index", - { - "group": "Root", - "pages": [ - "v3/api-ref/rest-api/server/root/health-check", - "v3/api-ref/rest-api/server/root/server-version", - "v3/api-ref/rest-api/server/root/hello", - "v3/api-ref/rest-api/server/root/perform-readiness-check" - ] - }, - { - "group": "Flows", - "pages": [ - "v3/api-ref/rest-api/server/flows/create-flow", - "v3/api-ref/rest-api/server/flows/read-flow", - "v3/api-ref/rest-api/server/flows/delete-flow", - "v3/api-ref/rest-api/server/flows/update-flow", - "v3/api-ref/rest-api/server/flows/count-flows", - "v3/api-ref/rest-api/server/flows/read-flow-by-name", - "v3/api-ref/rest-api/server/flows/read-flows", - "v3/api-ref/rest-api/server/flows/paginate-flows", - "v3/api-ref/rest-api/server/flows/count-deployments-by-flow", - "v3/api-ref/rest-api/server/flows/next-runs-by-flow" - ] - }, - { - "group": "Flow Runs", - "pages": [ - "v3/api-ref/rest-api/server/flow-runs/create-flow-run", - "v3/api-ref/rest-api/server/flow-runs/read-flow-run", - "v3/api-ref/rest-api/server/flow-runs/delete-flow-run", - "v3/api-ref/rest-api/server/flow-runs/update-flow-run", - "v3/api-ref/rest-api/server/flow-runs/count-flow-runs", - "v3/api-ref/rest-api/server/flow-runs/average-flow-run-lateness", - "v3/api-ref/rest-api/server/flow-runs/flow-run-history", - "v3/api-ref/rest-api/server/flow-runs/read-flow-run-graph-v1", - "v3/api-ref/rest-api/server/flow-runs/read-flow-run-graph-v2", - "v3/api-ref/rest-api/server/flow-runs/resume-flow-run", - "v3/api-ref/rest-api/server/flow-runs/read-flow-runs", - "v3/api-ref/rest-api/server/flow-runs/set-flow-run-state", - "v3/api-ref/rest-api/server/flow-runs/create-flow-run-input", - "v3/api-ref/rest-api/server/flow-runs/filter-flow-run-input", - "v3/api-ref/rest-api/server/flow-runs/read-flow-run-input", - "v3/api-ref/rest-api/server/flow-runs/delete-flow-run-input", - "v3/api-ref/rest-api/server/flow-runs/paginate-flow-runs", - "v3/api-ref/rest-api/server/flow-runs/download-logs", - "v3/api-ref/rest-api/server/flow-runs/update-flow-run-labels", - "v3/api-ref/rest-api/server/flow-runs/read-flow-run-history", - "v3/api-ref/rest-api/server/flow-runs/count-task-runs-by-flow-run" - ] - }, - { - "group": "Task Runs", - "pages": [ - "v3/api-ref/rest-api/server/task-runs/create-task-run", - "v3/api-ref/rest-api/server/task-runs/read-task-run", - "v3/api-ref/rest-api/server/task-runs/delete-task-run", - "v3/api-ref/rest-api/server/task-runs/update-task-run", - "v3/api-ref/rest-api/server/task-runs/count-task-runs", - "v3/api-ref/rest-api/server/task-runs/task-run-history", - "v3/api-ref/rest-api/server/task-runs/read-task-runs", - "v3/api-ref/rest-api/server/task-runs/set-task-run-state", - "v3/api-ref/rest-api/server/task-runs/read-dashboard-task-run-counts", - "v3/api-ref/rest-api/server/task-runs/read-task-run-counts-by-state" - ] - }, - { - "group": "Flow Run States", - "pages": [ - "v3/api-ref/rest-api/server/flow-run-states/read-flow-run-state", - "v3/api-ref/rest-api/server/flow-run-states/read-flow-run-states" - ] - }, - { - "group": "Task Run States", - "pages": [ - "v3/api-ref/rest-api/server/task-run-states/read-task-run-state", - "v3/api-ref/rest-api/server/task-run-states/read-task-run-states" - ] - }, - { - "group": "Flow Run Notification Policies", - "pages": [ - "v3/api-ref/rest-api/server/flow-run-notification-policies/create-flow-run-notification-policy", - "v3/api-ref/rest-api/server/flow-run-notification-policies/read-flow-run-notification-policy", - "v3/api-ref/rest-api/server/flow-run-notification-policies/delete-flow-run-notification-policy", - "v3/api-ref/rest-api/server/flow-run-notification-policies/update-flow-run-notification-policy", - "v3/api-ref/rest-api/server/flow-run-notification-policies/read-flow-run-notification-policies" - ] - }, - { - "group": "Deployments", - "pages": [ - "v3/api-ref/rest-api/server/deployments/create-deployment", - "v3/api-ref/rest-api/server/deployments/read-deployment", - "v3/api-ref/rest-api/server/deployments/delete-deployment", - "v3/api-ref/rest-api/server/deployments/update-deployment", - "v3/api-ref/rest-api/server/deployments/read-deployment-by-name", - "v3/api-ref/rest-api/server/deployments/read-deployments", - "v3/api-ref/rest-api/server/deployments/paginate-deployments", - "v3/api-ref/rest-api/server/deployments/get-scheduled-flow-runs-for-deployments", - "v3/api-ref/rest-api/server/deployments/count-deployments", - "v3/api-ref/rest-api/server/deployments/schedule-deployment", - "v3/api-ref/rest-api/server/deployments/resume-deployment", - "v3/api-ref/rest-api/server/deployments/pause-deployment", - "v3/api-ref/rest-api/server/deployments/create-flow-run-from-deployment", - "v3/api-ref/rest-api/server/deployments/work-queue-check-for-deployment", - "v3/api-ref/rest-api/server/deployments/read-deployment-schedules", - "v3/api-ref/rest-api/server/deployments/create-deployment-schedules", - "v3/api-ref/rest-api/server/deployments/delete-deployment-schedule", - "v3/api-ref/rest-api/server/deployments/update-deployment-schedule" - ] - }, - { - "group": "SavedSearches", - "pages": [ - "v3/api-ref/rest-api/server/savedsearches/create-saved-search", - "v3/api-ref/rest-api/server/savedsearches/read-saved-search", - "v3/api-ref/rest-api/server/savedsearches/delete-saved-search", - "v3/api-ref/rest-api/server/savedsearches/read-saved-searches" - ] - }, - { - "group": "Logs", - "pages": [ - "v3/api-ref/rest-api/server/logs/create-logs", - "v3/api-ref/rest-api/server/logs/read-logs" - ] - }, - { - "group": "Concurrency Limits", - "pages": [ - "v3/api-ref/rest-api/server/concurrency-limits/create-concurrency-limit", - "v3/api-ref/rest-api/server/concurrency-limits/read-concurrency-limit", - "v3/api-ref/rest-api/server/concurrency-limits/delete-concurrency-limit", - "v3/api-ref/rest-api/server/concurrency-limits/read-concurrency-limit-by-tag", - "v3/api-ref/rest-api/server/concurrency-limits/delete-concurrency-limit-by-tag", - "v3/api-ref/rest-api/server/concurrency-limits/read-concurrency-limits", - "v3/api-ref/rest-api/server/concurrency-limits/reset-concurrency-limit-by-tag", - "v3/api-ref/rest-api/server/concurrency-limits/increment-concurrency-limits-v1", - "v3/api-ref/rest-api/server/concurrency-limits/decrement-concurrency-limits-v1" - ] - }, - { - "group": "Concurrency Limits V2", - "pages": [ - "v3/api-ref/rest-api/server/concurrency-limits-v2/create-concurrency-limit-v2", - "v3/api-ref/rest-api/server/concurrency-limits-v2/read-concurrency-limit-v2", - "v3/api-ref/rest-api/server/concurrency-limits-v2/delete-concurrency-limit-v2", - "v3/api-ref/rest-api/server/concurrency-limits-v2/update-concurrency-limit-v2", - "v3/api-ref/rest-api/server/concurrency-limits-v2/read-all-concurrency-limits-v2", - "v3/api-ref/rest-api/server/concurrency-limits-v2/bulk-increment-active-slots", - "v3/api-ref/rest-api/server/concurrency-limits-v2/bulk-decrement-active-slots" - ] - }, - { - "group": "Block types", - "pages": [ - "v3/api-ref/rest-api/server/block-types/create-block-type", - "v3/api-ref/rest-api/server/block-types/read-block-type-by-id", - "v3/api-ref/rest-api/server/block-types/delete-block-type", - "v3/api-ref/rest-api/server/block-types/update-block-type", - "v3/api-ref/rest-api/server/block-types/read-block-type-by-slug", - "v3/api-ref/rest-api/server/block-types/read-block-types", - "v3/api-ref/rest-api/server/block-types/read-block-documents-for-block-type", - "v3/api-ref/rest-api/server/block-types/read-block-document-by-name-for-block-type", - "v3/api-ref/rest-api/server/block-types/install-system-block-types" - ] - }, - { - "group": "Block documents", - "pages": [ - "v3/api-ref/rest-api/server/block-documents/create-block-document", - "v3/api-ref/rest-api/server/block-documents/read-block-documents", - "v3/api-ref/rest-api/server/block-documents/count-block-documents", - "v3/api-ref/rest-api/server/block-documents/read-block-document-by-id", - "v3/api-ref/rest-api/server/block-documents/delete-block-document", - "v3/api-ref/rest-api/server/block-documents/update-block-document-data" - ] - }, - { - "group": "Work Pools", - "pages": [ - "v3/api-ref/rest-api/server/work-pools/create-work-pool", - "v3/api-ref/rest-api/server/work-pools/read-work-pool", - "v3/api-ref/rest-api/server/work-pools/delete-work-pool", - "v3/api-ref/rest-api/server/work-pools/update-work-pool", - "v3/api-ref/rest-api/server/work-pools/read-work-pools", - "v3/api-ref/rest-api/server/work-pools/count-work-pools", - "v3/api-ref/rest-api/server/work-pools/get-scheduled-flow-runs", - "v3/api-ref/rest-api/server/work-pools/create-work-queue", - "v3/api-ref/rest-api/server/work-pools/read-work-queue", - "v3/api-ref/rest-api/server/work-pools/delete-work-queue", - "v3/api-ref/rest-api/server/work-pools/update-work-queue", - "v3/api-ref/rest-api/server/work-pools/read-work-queues", - "v3/api-ref/rest-api/server/work-pools/worker-heartbeat", - "v3/api-ref/rest-api/server/work-pools/read-workers", - "v3/api-ref/rest-api/server/work-pools/delete-worker" - ] - }, - { - "group": "Task Workers", - "pages": [ - "v3/api-ref/rest-api/server/task-workers/read-task-workers" - ] - }, - { - "group": "Work Queues", - "pages": [ - "v3/api-ref/rest-api/server/work-queues/create-work-queue", - "v3/api-ref/rest-api/server/work-queues/read-work-queue", - "v3/api-ref/rest-api/server/work-queues/delete-work-queue", - "v3/api-ref/rest-api/server/work-queues/update-work-queue", - "v3/api-ref/rest-api/server/work-queues/read-work-queue-by-name", - "v3/api-ref/rest-api/server/work-queues/read-work-queue-runs", - "v3/api-ref/rest-api/server/work-queues/read-work-queues", - "v3/api-ref/rest-api/server/work-queues/read-work-queue-status" - ] - }, - { - "group": "Artifacts", - "pages": [ - "v3/api-ref/rest-api/server/artifacts/create-artifact", - "v3/api-ref/rest-api/server/artifacts/read-artifact", - "v3/api-ref/rest-api/server/artifacts/delete-artifact", - "v3/api-ref/rest-api/server/artifacts/update-artifact", - "v3/api-ref/rest-api/server/artifacts/read-latest-artifact", - "v3/api-ref/rest-api/server/artifacts/read-artifacts", - "v3/api-ref/rest-api/server/artifacts/read-latest-artifacts", - "v3/api-ref/rest-api/server/artifacts/count-artifacts", - "v3/api-ref/rest-api/server/artifacts/count-latest-artifacts" - ] - }, - { - "group": "Block schemas", - "pages": [ - "v3/api-ref/rest-api/server/block-schemas/create-block-schema", - "v3/api-ref/rest-api/server/block-schemas/read-block-schema-by-id", - "v3/api-ref/rest-api/server/block-schemas/delete-block-schema", - "v3/api-ref/rest-api/server/block-schemas/read-block-schemas", - "v3/api-ref/rest-api/server/block-schemas/read-block-schema-by-checksum" - ] - }, - { - "group": "Block capabilities", - "pages": [ - "v3/api-ref/rest-api/server/block-capabilities/read-available-block-capabilities" - ] - }, - { - "group": "Collections", - "pages": [ - "v3/api-ref/rest-api/server/collections/read-view-content" - ] - }, - { - "group": "Variables", - "pages": [ - "v3/api-ref/rest-api/server/variables/create-variable", - "v3/api-ref/rest-api/server/variables/read-variable", - "v3/api-ref/rest-api/server/variables/delete-variable", - "v3/api-ref/rest-api/server/variables/update-variable", - "v3/api-ref/rest-api/server/variables/read-variable-by-name", - "v3/api-ref/rest-api/server/variables/delete-variable-by-name", - "v3/api-ref/rest-api/server/variables/update-variable-by-name", - "v3/api-ref/rest-api/server/variables/read-variables", - "v3/api-ref/rest-api/server/variables/count-variables" - ] - }, - "v3/api-ref/rest-api/server/create-csrf-token", - { - "group": "Events", - "pages": [ - "v3/api-ref/rest-api/server/events/create-events", - "v3/api-ref/rest-api/server/events/read-events", - "v3/api-ref/rest-api/server/events/read-account-events-page", - "v3/api-ref/rest-api/server/events/count-account-events" - ] - }, - { - "group": "Automations", - "pages": [ - "v3/api-ref/rest-api/server/automations/create-automation", - "v3/api-ref/rest-api/server/automations/read-automation", - "v3/api-ref/rest-api/server/automations/update-automation", - "v3/api-ref/rest-api/server/automations/delete-automation", - "v3/api-ref/rest-api/server/automations/patch-automation", - "v3/api-ref/rest-api/server/automations/read-automations", - "v3/api-ref/rest-api/server/automations/count-automations", - "v3/api-ref/rest-api/server/automations/read-automations-related-to-resource", - "v3/api-ref/rest-api/server/automations/delete-automations-owned-by-resource", - "v3/api-ref/rest-api/server/automations/validate-template" - ] - }, - { - "group": "UI", - "pages": [ - "v3/api-ref/rest-api/server/ui/validate-obj" - ] - }, - { - "group": "Admin", - "pages": [ - "v3/api-ref/rest-api/server/admin/read-settings", - "v3/api-ref/rest-api/server/admin/read-version", - "v3/api-ref/rest-api/server/admin/clear-database", - "v3/api-ref/rest-api/server/admin/drop-database", - "v3/api-ref/rest-api/server/admin/create-database" - ] - } - ], - "version": "v3" - } - ], - "version": "v3" - } - ], - "version": "v3" - }, - { - "group": "Contribute", - "pages": [ - "contribute/index", - "contribute/docs-contribute", - "contribute/dev-contribute", - "contribute/contribute-integrations", - "contribute/styles-practices", - "contribute/code-of-conduct" - ] - } - ], - "redirects": [ - { - "destination": "/v3/getting-started/:slug*", - "source": "/getting-started/:slug*" - }, - { - "destination": "/v3/tutorial/:slug*", - "source": "/tutorial/:slug*" - }, - { - "destination": "/v3/guides/:slug*", - "source": "/guides/:slug*" - }, - { - "destination": "/v3/concepts/:slug*", - "source": "/concepts/:slug*" - }, - { - "destination": "/v3/cloud/:slug*", - "source": "/cloud/:slug*" - }, - { - "destination": "/v3/api-ref/:slug*", - "source": "/api-ref/:slug*" - }, - { - "destination": "/v3/get-started", - "source": "/latest/tutorial" - }, - { - "destination": "/v3/get-started", - "source": "/latest/getting-started/quickstart" - }, - { - "destination": "/v3/develop/write-flows", - "source": "/latest/concepts/flows" - }, - { - "destination": "/v3/deploy", - "source": "/latest/concepts/deployments" - }, - { - "destination": "/v3/get-started/install", - "source": "/latest/getting-started/installation" - }, - { - "destination": "/v3/deploy/infrastructure-concepts/work-pools", - "source": "/latest/concepts/work-pools" - }, - { - "destination": "/v3/manage/self-host", - "source": "/latest/guides/host" - }, - { - "destination": "/v3/develop/write-tasks", - "source": "/latest/concepts/tasks" - }, - { - "destination": "/v3/develop/settings-and-profiles", - "source": "/v3/manage/settings-and-profiles" - }, - { - "destination": "/v3", - "source": "/latest/guides" - }, - { - "destination": "/v3/deploy", - "source": "/latest/tutorial/deployments" - }, - { - "destination": "/v3/develop/write-flows", - "source": "/latest/tutorial/flows" - }, - { - "destination": "/v3", - "source": "/latest/concepts" - }, - { - "destination": "/v3/deploy", - "source": "/latest/guides/prefect-deploy" - }, - { - "destination": "/v3/develop/write-tasks", - "source": "/latest/tutorial/tasks" - }, - { - "destination": "/v3/automate/add-schedules", - "source": "/latest/concepts/schedules" - }, - { - "destination": "/v3/deploy/infrastructure-examples/docker", - "source": "/latest/guides/docker" - }, - { - "destination": "/v3/deploy/infrastructure-concepts/work-pools", - "source": "/latest/tutorial/work-pools" - }, - { - "destination": "/v3/develop/settings-and-profiles", - "source": "/latest/guides/settings" - }, - { - "destination": "/v3/develop/task-runners", - "source": "/latest/concepts/task-runners" - }, - { - "destination": "/v3/deploy/infrastructure-concepts/workers", - "source": "/latest/tutorial/workers" - }, - { - "destination": "/v3/manage/cloud", - "source": "/latest/cloud" - }, - { - "destination": "/v3/integrations", - "source": "/latest/integrations" - }, - { - "destination": "/v3/develop/results", - "source": "/latest/concepts/results" - }, - { - "destination": "/v3/automate", - "source": "/latest/concepts/automations" - }, - { - "destination": "/v3/develop/logging", - "source": "/latest/guides/logs" - }, - { - "destination": "/v3/develop/blocks", - "source": "/latest/concepts/blocks" - }, - { - "destination": "/v3/deploy/infrastructure-examples/kubernetes", - "source": "/latest/guides/deployment/kubernetes" - }, - { - "destination": "/v3/develop/manage-states", - "source": "/latest/concepts/states" - }, - { - "destination": "/v3/resources/upgrade-agents-to-workers", - "source": "/latest/guides/upgrade-guide-agents-to-workers" - }, - { - "destination": "/v3/automate/events/webhook-triggers", - "source": "/latest/guides/webhooks" - }, - { - "destination": "/v3/automate/events/webhook-triggers", - "source": "/latest/cloud/webhooks" - }, - { - "destination": "/v3/develop/artifacts", - "source": "/latest/concepts/artifacts" - }, - { - "destination": "/v3/api-ref/rest-api", - "source": "/latest/api-ref/rest-api-reference" - }, - { - "destination": "/v3/develop/global-concurrency-limits", - "source": "/latest/guides/global-concurrency-limits" - }, - { - "destination": "/v3/develop/variables", - "source": "/latest/guides/variables" - }, - { - "destination": "/v3/api-ref", - "source": "/latest/guides/using-the-client" - }, - { - "destination": "/v3/deploy/infrastructure-concepts/store-flow-code", - "source": "/latest/guides/deployment/storage-guide" - }, - { - "destination": "/v3/develop/test-workflows", - "source": "/latest/guides/testing" - }, - { - "destination": "/v3/deploy/infrastructure-examples/serverless", - "source": "/latest/guides/deployment/push-work-pools" - }, - { - "destination": "/v3/develop/inputs", - "source": "/latest/guides/creating-interactive-workflows" - }, - { - "destination": "/integrations/prefect-dask/usage_guide", - "source": "/latest/guides/dask-ray-task-runners" - }, - { - "destination": "/v3/deploy/infrastructure-concepts/deploy-ci-cd", - "source": "/latest/guides/ci-cd" - }, - { - "destination": "/v3/resources/upgrade-agents-to-workers", - "source": "/latest/concepts/deployments-block-based" - }, - { - "destination": "/v3/deploy/infrastructure-concepts/work-pools", - "source": "/latest/concepts/infrastructure" - }, - { - "destination": "/v3/develop/runtime-context", - "source": "/latest/guides/runtime-context" - }, - { - "destination": "/v3/deploy/infrastructure-concepts/customize", - "source": "/latest/guides/deployment/overriding-job-variables" - }, - { - "destination": "/v3/deploy/infrastructure-examples/managed", - "source": "/latest/guides/managed-execution" - }, - { - "destination": "/v3/develop/write-flows", - "source": "/latest/guides/specifying-upstream-dependencies" - }, - { - "destination": "/v3/automate", - "source": "/latest/guides/automations" - }, - { - "destination": "/v3/resources/upgrade-agents-to-workers", - "source": "/latest/concepts/agents" - }, - { - "destination": "/integrations/prefect-aws", - "source": "/latest/integrations/prefect-aws" - }, - { - "destination": "/v3/deploy/infrastructure-concepts/store-flow-code", - "source": "/latest/concepts/storage" - }, - { - "destination": "/v3/deploy/daemonize-processes", - "source": "/latest/guides/deployment/daemonize" - }, - { - "destination": "/v3/manage/cloud/manage-users/api-keys", - "source": "/latest/cloud/users/api-keys" - }, - { - "destination": "/v3/contribute", - "source": "/latest/community" - }, - { - "destination": "/v3/develop/blocks", - "source": "/latest/concepts/filesystems" - }, - { - "destination": "/v3/events", - "source": "/latest/cloud/events" - }, - { - "destination": "/v3", - "source": "/latest/recipes/recipes" - }, - { - "destination": "/v3/develop/cli-shell", - "source": "/latest/guides/cli-shell" - }, - { - "destination": "/v3/api-ref/rest-api/server", - "source": "/latest/api-ref/server" - }, - { - "destination": "/v3/develop/blocks", - "source": "/latest/guides/moving-data" - }, - { - "destination": "/contribute/develop-a-new-worker-type", - "source": "/latest/guides/deployment/developing-a-new-worker-type" - }, - { - "destination": "/v3/develop/manage-states", - "source": "/latest/guides/state-change-hooks" - }, - { - "destination": "/v3/deploy/infrastructure-examples/serverless", - "source": "/latest/guides/deployment/serverless-workers" - }, - { - "destination": "/integrations/integrations", - "source": "/latest/integrations/usage" - }, - { - "destination": "/v3/manage/cloud/troubleshoot-cloud", - "source": "/latest/guides/troubleshooting" - }, - { - "destination": "/v3/develop/big-data", - "source": "/latest/guides/big-data" - }, - { - "destination": "/v3/manage/cloud/workspaces", - "source": "/latest/cloud/workspaces" - }, - { - "destination": "/integrations/prefect-aws/ecs_guide", - "source": "/latest/integrations/prefect-aws/ecs_guide" - }, - { - "destination": "/integrations/prefect-kubernetes", - "source": "/latest/integrations/prefect-kubernetes" - }, - { - "destination": "/v3/get-started/whats-new-prefect-3", - "source": "/latest/faq" - }, - { - "destination": "/v3/resources/upgrade-to-prefect-3", - "source": "/latest/guides/migration-guide" - }, - { - "destination": "/integrations/prefect-dbt", - "source": "/latest/integrations/prefect-dbt" - }, - { - "destination": "/integrations/prefect-aws/ecs_guide", - "source": "/latest/integrations/prefect-aws/ecs_worker" - }, - { - "destination": "/v3/contribute", - "source": "/latest/contributing/overview" - }, - { - "destination": "/v3/develop/secrets", - "source": "/latest/guides/secrets" - }, - { - "destination": "/v3/manage/cloud/connect-to-cloud", - "source": "/latest/cloud/connecting" - }, - { - "destination": "/v3/manage/cloud/manage-users/manage-roles", - "source": "/latest/cloud/users/roles" - }, - { - "destination": "/integrations/prefect-docker", - "source": "/latest/integrations/prefect-docker" - }, - { - "destination": "/v3/manage/cloud/manage-users", - "source": "/latest/cloud/users" - }, - { - "destination": "/integrations/prefect-gcp", - "source": "/v3/integrations/prefect-gcp" - }, - { - "destination": "/latest/manage/cloud/manage-users/configure-sso", - "source": "/latest/cloud/users/sso" - }, - { - "destination": "/integrations/prefect-dask", - "source": "/latest/integrations/prefect-dask" - }, - { - "destination": "/integrations/prefect-gcp/gcp-worker-guide", - "source": "/latest/integrations/prefect-gcp/gcp-worker-guide" - }, - { - "destination": "/v3/manage/cloud/rate-limits", - "source": "/latest/cloud/rate-limits" - }, - { - "destination": "/integrations/prefect-sqlalchemy", - "source": "/latest/integrations/prefect-sqlalchemy" - }, - { - "destination": "/integrations/prefect-slack", - "source": "/latest/integrations/prefect-slack" - }, - { - "destination": "/integrations/prefect-gitlab", - "source": "/latest/integrations/prefect-gitlab" - }, - { - "destination": "/integrations/prefect-dbt", - "source": "/latest/integrations/prefect-dbt/cli/commands" - }, - { - "destination": "/integrations/prefect-databricks", - "source": "/latest/integrations/prefect-databricks" - }, - { - "destination": "/latest/manage/cloud/manage-users/service-accounts", - "source": "/latest/cloud/users/service-accounts" - }, - { - "destination": "/integrations/prefect-shell", - "source": "/latest/integrations/prefect-shell" - }, - { - "destination": "/integrations/prefect-azure", - "source": "/latest/integrations/prefect-azure" - }, - { - "destination": "/integrations/prefect-azure/aci_worker#why-use-aci-for-flow-run-execution", - "source": "/latest/guides/deployment/aci" - }, - { - "destination": "/v3/api-ref/python", - "source": "/latest/api-ref/server/api/deployments" - }, - { - "destination": "/integrations/prefect-github", - "source": "/latest/integrations/prefect-github" - }, - { - "destination": "/integrations/prefect-aws", - "source": "/latest/integrations/prefect-aws/s3" - }, - { - "destination": "/v3/api-ref", - "source": "/latest/api-ref/server/api/flow_runs" - }, - { - "destination": "/latest/automate/incidents", - "source": "/latest/cloud/incidents" - }, - { - "destination": "/integrations/prefect-aws", - "source": "/latest/integrations/prefect-aws/ecs" - }, - { - "destination": "/integrations/prefect-email", - "source": "/latest/integrations/prefect-email" - }, - { - "destination": "/integrations/prefect-snowflake", - "source": "/latest/integrations/prefect-snowflake" - }, - { - "destination": "/contribute/contribute-integrations", - "source": "/latest/integrations/contribute" - }, - { - "destination": "/integrations/prefect-aws", - "source": "/latest/integrations/prefect-aws/lambda_function" - }, - { - "destination": "/integrations/prefect-docker", - "source": "/latest/integrations/prefect-docker/host" - }, - { - "destination": "/integrations/prefect-docker", - "source": "/latest/integrations/prefect-docker/worker" - }, - { - "destination": "/v3/api-ref/python", - "source": "/latest/api-ref/server/schemas/schedules" - }, - { - "destination": "/integrations/prefect-docker", - "source": "/latest/integrations/prefect-docker/deployments/steps" - }, - { - "destination": "/integrations/prefect-ray", - "source": "/latest/integrations/prefect-ray" - }, - { - "destination": "/v3/deploy/infrastructure-examples/kubernetes", - "source": "/implementation/azure/aks" - }, - { - "destination": "/v3/api-ref/python", - "source": "/latest/api-ref/server/models/flow_runs" - }, - { - "destination": "/integrations/prefect-gcp", - "source": "/latest/integrations/prefect-gcp/bigquery" - }, - { - "destination": "/integrations/prefect-sqlalchemy", - "source": "/latest/integrations/prefect-sqlalchemy/database" - }, - { - "destination": "/contribute/styles-practices", - "source": "/latest/contributing/versioning" - }, - { - "destination": "/integrations/prefect-dask", - "source": "/latest/integrations/prefect-dask/task_runners" - }, - { - "destination": "/integrations/prefect-dask", - "source": "/latest/integrations/prefect-dask/usage_guide" - }, - { - "destination": "/integrations/prefect-shell", - "source": "/latest/integrations/prefect-shell/commands" - }, - { - "destination": "/integrations/prefect-azure/aci_worker", - "source": "/latest/integrations/prefect-azure/aci_worker" - }, - { - "destination": "/integrations/prefect-aws", - "source": "/latest/integrations/prefect-aws/batch" - }, - { - "destination": "/integrations/prefect-docker", - "source": "/latest/integrations/prefect-docker/containers" - }, - { - "destination": "/v3/api-ref/rest-api/server/flows", - "source": "/latest/api-ref/server/api/flows" - }, - { - "destination": "/v3/api-ref", - "source": "/latest/api-ref/server/schemas/filters" - }, - { - "destination": "/integrations/prefect-docker", - "source": "/latest/integrations/prefect-docker/images" - }, - { - "destination": "/contribute/styles-practices", - "source": "/latest/contributing/style" - }, - { - "destination": "/integrations/prefect-docker", - "source": "/latest/integrations/prefect-docker/credentials" - }, - { - "destination": "/integrations/prefect-gcp", - "source": "/latest/integrations/prefect-gcp/cloud_storage" - }, - { - "destination": "/v3/api-ref", - "source": "/latest/api-ref/server/api/admin" - }, - { - "destination": "/v3/api-ref", - "source": "/latest/api-ref/server/api/server" - }, - { - "destination": "/v3/manage/cloud/manage-users/object-access-control-lists", - "source": "/latest/cloud/users/object-access-control-lists" - }, - { - "destination": "/integrations/prefect-aws", - "source": "/latest/integrations/prefect-aws/secrets_manager" - }, - { - "destination": "/integrations/prefect-aws", - "source": "/latest/integrations/prefect-aws/credentials" - }, - { - "destination": "/integrations/prefect-databricks", - "source": "/latest/integrations/prefect-databricks/jobs" - }, - { - "destination": "/integrations/prefect-databricks", - "source": "/latest/integrations/prefect-databricks/models/jobs" - }, - { - "destination": "/integrations/prefect-kubernetes", - "source": "/latest/integrations/prefect-kubernetes/worker" - }, - { - "destination": "/integrations/prefect-sqlalchemy", - "source": "/latest/integrations/prefect-sqlalchemy/credentials" - }, - { - "destination": "/integrations/prefect-databricks", - "source": "/latest/integrations/prefect-databricks/flows" - }, - { - "destination": "/integrations/prefect-kubernetes", - "source": "/latest/integrations/prefect-kubernetes/deployments" - }, - { - "destination": "/integrations/prefect-snowflake", - "source": "/latest/integrations/prefect-snowflake/credentials" - }, - { - "destination": "/integrations/prefect-dbt", - "source": "/latest/integrations/prefect-dbt/cli/credentials" - }, - { - "destination": "/integrations/prefect-kubernetes", - "source": "/latest/integrations/prefect-kubernetes/jobs" - }, - { - "destination": "/integrations/prefect-slack", - "source": "/latest/integrations/prefect-slack/messages" - }, - { - "destination": "/v3/get-started/whats-new-prefect-3", - "source": "/v3/resources/whats-new-prefect-3" - }, - { - "destination": "/v3/develop/deferred-tasks", - "source": "/v3/resources/deferred-tasks" - }, - { - "destination": "/v3/develop/visualize-flow-structure", - "source": "/v3/resources/visualize-flow-structure" - }, - { - "destination": "/v3/develop/big-data", - "source": "/v3/resources/big-data" - }, - { - "destination": "/v3/develop/cli-shell", - "source": "/v3/resources/cli-shell" - }, - { - "destination": "/v3/develop/secrets", - "source": "/v3/resources/secrets" - }, - { - "destination": "/v3/develop/cancel", - "source": "/v3/resources/cancel" - }, - { - "destination": "/v3/deploy/daemonize-processes", - "source": "/v3/resources/daemonize-processes" - }, - { - "destination": "/v3/develop/interact-with-api", - "source": "/v3/resources/interact-with-api" - }, - { - "destination": "/v3/api-ref/python", - "source": "/latest/api-ref/prefect/:slug*" - }, - { - "destination": "/v3/api-ref/python", - "source": "/api-ref/prefect/:slug*" - }, - { - "destination": "/v3/:slug*", - "source": "/3rc/:slug*" - }, - { - "destination": "/v3/:slug*", - "source": "/latest/:slug*" - }, - { - "destination": "/v3/:slug*", - "source": "/3/:slug*" - }, - { - "destination": "/v3/:slug*", - "source": "/3.0/:slug*" - }, - { - "destination": "/v2/:slug*", - "source": "/2/:slug*" - } - ], - "tabs": [ - { - "name": "APIs & SDK", - "url": "v3/api-ref" - }, - { - "name": "Integrations", - "url": "integrations" - }, - { - "name": "Contribute", - "url": "contribute" - } - ], - "topbarCtaButton": { - "type": "github", - "url": "https://github.com/PrefectHQ/Prefect" - }, - "versions": [ - "v3", - "v2" - ] -} \ No newline at end of file diff --git a/docs/overrides/main.html b/docs/overrides/main.html new file mode 100644 index 000000000000..6c2a8d1728ad --- /dev/null +++ b/docs/overrides/main.html @@ -0,0 +1,21 @@ +{% extends "base.html" %} + +{% block extrahead %} + +{{ super() }} +{% endblock %} + + +{% block analytics %} +{{ super() }} +{% endblock %} +sss +{% block announce %} +
+ + Prefect 3 is Generally Available! See the docs at + docs.prefect.io + +
+ +{% endblock %} \ No newline at end of file diff --git a/docs/v3/api-ref/rest-api/server/schema.json b/docs/v3/api-ref/rest-api/server/schema.json index 3e4acc39393f..5b4d5505b4b7 100644 --- a/docs/v3/api-ref/rest-api/server/schema.json +++ b/docs/v3/api-ref/rest-api/server/schema.json @@ -2,7 +2,7 @@ "openapi": "3.1.0", "info": { "title": "Prefect Prefect REST API", - "version": "v3", + "version": "3.1.0", "x-logo": { "url": "static/prefect-logo-mark-gradient.png" } diff --git a/scripts/generate_mintlify_openapi_docs.py b/scripts/generate_mintlify_openapi_docs.py index 147d986da906..85e1aa9e601e 100755 --- a/scripts/generate_mintlify_openapi_docs.py +++ b/scripts/generate_mintlify_openapi_docs.py @@ -3,18 +3,12 @@ import subprocess import sys from pathlib import Path -from typing import Any from packaging.version import Version from prefect.server.api.server import create_app -Mint = dict[str, Any] -Navigation = list[dict[str, Any]] -SinglePage = str -PageGroup = dict[str, Any] - -MINTLIFY_SCRAPE = ["npx", "--yes", "@mintlify/scraping@3.0.123"] +MINTLIFY_SCRAPE = ["npx", "--yes", "@mintlify/scraping@4.0.106"] def docs_path() -> Path: @@ -22,8 +16,8 @@ def docs_path() -> Path: """Load the overall Mintlify configuration file""" -with open(docs_path() / "mint.json", "r") as f: - mint_json = json.load(f) +with open(docs_path() / "docs.json", "r") as f: + docs_json = json.load(f) def current_version() -> str: @@ -45,19 +39,22 @@ def main(): suggestions = generate_schema_documentation(version, server_docs_path) # Find the "Server API" section and replace the "pages" content other than the index - for group in mint_json["navigation"]: - if group["group"] == "APIs & SDK" and group["version"] == version: - for sub_group in group["pages"]: - if isinstance(sub_group, dict) and sub_group["group"] == "REST API": - for rest_group in sub_group["pages"]: - if ( - isinstance(rest_group, dict) - and rest_group["group"] == "Server API" - ): - rest_group["pages"][1:] = suggestions - - # Write out the updated mint.json file - write_mint(mint_json) + for version in docs_json["navigation"]["versions"]: + if version["version"] == "v3": + # Iterate over the tabs in version v3 + for tab in version["tabs"]: + if tab["tab"] == "APIs & SDK": + for group in tab["groups"]: + if group["group"] == "APIs & SDK": + for rest_group in group["pages"]: + if ( + isinstance(rest_group, dict) + and rest_group["group"] == "Server API" + ): + rest_group["pages"][1:] = suggestions + + # Write out the updated docs.json file + write_mint(docs_json) def ensure_npx_environment(): @@ -71,11 +68,11 @@ def ensure_npx_environment(): sys.exit(1) -def generate_schema_documentation(version: str, server_docs_path: Path) -> Navigation: +def generate_schema_documentation(version: str, server_docs_path: Path): """Writes the current OpenAPI schema to the given path, generates documentation files from it, then returns Mintlify's recommended navigation updates.""" openapi_schema = create_app().openapi() - openapi_schema["info"]["version"] = version + openapi_schema["info"]["version"] = "3.1.0" schema_path = server_docs_path / "schema.json" with open(schema_path, "w") as f: @@ -108,10 +105,10 @@ def generate_schema_documentation(version: str, server_docs_path: Path) -> Navig return suggestions -def write_mint(update_mint_json: Mint): - """Write updated mint.json file out""" - with open(docs_path() / "mint.json", "w") as f: - json.dump(update_mint_json, f, indent=2, ensure_ascii=False) +def write_mint(update_docs_json): + """Write updated docs.json file out""" + with open(docs_path() / "docs.json", "w") as f: + json.dump(update_docs_json, f, indent=2, ensure_ascii=False) if __name__ == "__main__": From b653ea8e5192ef8de81275fd2451db6932f5b81f Mon Sep 17 00:00:00 2001 From: Jeff Hale Date: Tue, 4 Feb 2025 14:05:05 -0500 Subject: [PATCH 02/13] match --- scripts/generate_mintlify_openapi_docs.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/scripts/generate_mintlify_openapi_docs.py b/scripts/generate_mintlify_openapi_docs.py index 85e1aa9e601e..9819c8e12182 100755 --- a/scripts/generate_mintlify_openapi_docs.py +++ b/scripts/generate_mintlify_openapi_docs.py @@ -72,7 +72,7 @@ def generate_schema_documentation(version: str, server_docs_path: Path): """Writes the current OpenAPI schema to the given path, generates documentation files from it, then returns Mintlify's recommended navigation updates.""" openapi_schema = create_app().openapi() - openapi_schema["info"]["version"] = "3.1.0" + openapi_schema["info"]["version"] = version schema_path = server_docs_path / "schema.json" with open(schema_path, "w") as f: From c3cd25ae43f3e86c5e7ac79992b77eb067cda46c Mon Sep 17 00:00:00 2001 From: Jeff Hale Date: Tue, 4 Feb 2025 14:15:36 -0500 Subject: [PATCH 03/13] Update static-analysis.yaml --- .github/workflows/static-analysis.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/static-analysis.yaml b/.github/workflows/static-analysis.yaml index 2c08b587f306..880798b02da6 100644 --- a/.github/workflows/static-analysis.yaml +++ b/.github/workflows/static-analysis.yaml @@ -62,7 +62,7 @@ jobs: cache-dependency-path: "**/package-lock.json" - name: Install mintlify-scrape - run: npm install -g @mintlify/scraping + run: npm install -g @mintlify/scraping@4.0.106 - name: Run pre-commit run: | From d1cb4f0605e77eaee0c8283bfab2637d7074e8c5 Mon Sep 17 00:00:00 2001 From: Jeff Hale Date: Tue, 4 Feb 2025 14:28:42 -0500 Subject: [PATCH 04/13] Update docs/v3/api-ref/rest-api/server/schema.json --- docs/v3/api-ref/rest-api/server/schema.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/v3/api-ref/rest-api/server/schema.json b/docs/v3/api-ref/rest-api/server/schema.json index 5b4d5505b4b7..3e4acc39393f 100644 --- a/docs/v3/api-ref/rest-api/server/schema.json +++ b/docs/v3/api-ref/rest-api/server/schema.json @@ -2,7 +2,7 @@ "openapi": "3.1.0", "info": { "title": "Prefect Prefect REST API", - "version": "3.1.0", + "version": "v3", "x-logo": { "url": "static/prefect-logo-mark-gradient.png" } From b260cd39ae6c7b56d3c23741d9177a89fb9be45c Mon Sep 17 00:00:00 2001 From: Jeff Hale Date: Tue, 4 Feb 2025 14:35:15 -0500 Subject: [PATCH 05/13] Update .github/workflows/static-analysis.yaml --- .github/workflows/static-analysis.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/static-analysis.yaml b/.github/workflows/static-analysis.yaml index 880798b02da6..cd958bfea9fd 100644 --- a/.github/workflows/static-analysis.yaml +++ b/.github/workflows/static-analysis.yaml @@ -62,7 +62,7 @@ jobs: cache-dependency-path: "**/package-lock.json" - name: Install mintlify-scrape - run: npm install -g @mintlify/scraping@4.0.106 + run: npm install -g @mintlify/scraping@4.0.107 - name: Run pre-commit run: | From 244b9b36790ea6e6fb35548621101d2a17ebe040 Mon Sep 17 00:00:00 2001 From: Jeff Hale Date: Tue, 4 Feb 2025 14:35:53 -0500 Subject: [PATCH 06/13] Update scripts/generate_mintlify_openapi_docs.py --- scripts/generate_mintlify_openapi_docs.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/scripts/generate_mintlify_openapi_docs.py b/scripts/generate_mintlify_openapi_docs.py index 9819c8e12182..f8bc3746d8bd 100755 --- a/scripts/generate_mintlify_openapi_docs.py +++ b/scripts/generate_mintlify_openapi_docs.py @@ -8,7 +8,7 @@ from prefect.server.api.server import create_app -MINTLIFY_SCRAPE = ["npx", "--yes", "@mintlify/scraping@4.0.106"] +MINTLIFY_SCRAPE = ["npx", "--yes", "@mintlify/scraping@4.0.107"] def docs_path() -> Path: From a5af0b6f8b73faef941c8b5f5808b5f09be69a44 Mon Sep 17 00:00:00 2001 From: Jeff Hale Date: Tue, 4 Feb 2025 14:49:38 -0500 Subject: [PATCH 07/13] Delete docs/overrides/main.html --- docs/overrides/main.html | 21 --------------------- 1 file changed, 21 deletions(-) delete mode 100644 docs/overrides/main.html diff --git a/docs/overrides/main.html b/docs/overrides/main.html deleted file mode 100644 index 6c2a8d1728ad..000000000000 --- a/docs/overrides/main.html +++ /dev/null @@ -1,21 +0,0 @@ -{% extends "base.html" %} - -{% block extrahead %} - -{{ super() }} -{% endblock %} - - -{% block analytics %} -{{ super() }} -{% endblock %} -sss -{% block announce %} -
- - Prefect 3 is Generally Available! See the docs at - docs.prefect.io - -
- -{% endblock %} \ No newline at end of file From 2208d20cad2bea6d3993de52c94f0192d0f24a1f Mon Sep 17 00:00:00 2001 From: Jeff Hale Date: Tue, 4 Feb 2025 15:47:54 -0500 Subject: [PATCH 08/13] Update static-analysis.yaml --- .github/workflows/static-analysis.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/static-analysis.yaml b/.github/workflows/static-analysis.yaml index cd958bfea9fd..e3ca7ddcd3c0 100644 --- a/.github/workflows/static-analysis.yaml +++ b/.github/workflows/static-analysis.yaml @@ -62,7 +62,7 @@ jobs: cache-dependency-path: "**/package-lock.json" - name: Install mintlify-scrape - run: npm install -g @mintlify/scraping@4.0.107 + run: npm install -g @mintlify/scraping@4.0.108 - name: Run pre-commit run: | From 7ffb886daf4535cc4b2c4d73b3c2fd673a52f5ce Mon Sep 17 00:00:00 2001 From: Jeff Hale Date: Tue, 4 Feb 2025 15:49:25 -0500 Subject: [PATCH 09/13] Update scripts/generate_mintlify_openapi_docs.py --- scripts/generate_mintlify_openapi_docs.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/scripts/generate_mintlify_openapi_docs.py b/scripts/generate_mintlify_openapi_docs.py index f8bc3746d8bd..2657149c3d3d 100755 --- a/scripts/generate_mintlify_openapi_docs.py +++ b/scripts/generate_mintlify_openapi_docs.py @@ -8,7 +8,7 @@ from prefect.server.api.server import create_app -MINTLIFY_SCRAPE = ["npx", "--yes", "@mintlify/scraping@4.0.107"] +MINTLIFY_SCRAPE = ["npx", "--yes", "@mintlify/scraping@4.0.108"] def docs_path() -> Path: From 46513d6d672d9481ed51f526be1eabc9d1a631c7 Mon Sep 17 00:00:00 2001 From: Jeff Hale Date: Wed, 5 Feb 2025 12:14:37 -0500 Subject: [PATCH 10/13] Update .github/workflows/static-analysis.yaml --- .github/workflows/static-analysis.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/static-analysis.yaml b/.github/workflows/static-analysis.yaml index e3ca7ddcd3c0..b33951c8e6bd 100644 --- a/.github/workflows/static-analysis.yaml +++ b/.github/workflows/static-analysis.yaml @@ -62,7 +62,7 @@ jobs: cache-dependency-path: "**/package-lock.json" - name: Install mintlify-scrape - run: npm install -g @mintlify/scraping@4.0.108 + run: npm install -g @mintlify/scraping@4.0.110 - name: Run pre-commit run: | From 4c5f828de36a1b61ca6b78590294303d2989d4a8 Mon Sep 17 00:00:00 2001 From: Jeff Hale Date: Wed, 5 Feb 2025 12:15:03 -0500 Subject: [PATCH 11/13] Update scripts/generate_mintlify_openapi_docs.py --- scripts/generate_mintlify_openapi_docs.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/scripts/generate_mintlify_openapi_docs.py b/scripts/generate_mintlify_openapi_docs.py index 2657149c3d3d..cd8d65f21595 100755 --- a/scripts/generate_mintlify_openapi_docs.py +++ b/scripts/generate_mintlify_openapi_docs.py @@ -8,7 +8,7 @@ from prefect.server.api.server import create_app -MINTLIFY_SCRAPE = ["npx", "--yes", "@mintlify/scraping@4.0.108"] +MINTLIFY_SCRAPE = ["npx", "--yes", "@mintlify/scraping@4.0.110"] def docs_path() -> Path: From 821489eb22cca07840ffbdb6c8bb76104e371a36 Mon Sep 17 00:00:00 2001 From: Jeff Hale Date: Thu, 6 Feb 2025 12:26:14 -0500 Subject: [PATCH 12/13] Update .github/workflows/static-analysis.yaml --- .github/workflows/static-analysis.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/static-analysis.yaml b/.github/workflows/static-analysis.yaml index b33951c8e6bd..0ac38f6151fa 100644 --- a/.github/workflows/static-analysis.yaml +++ b/.github/workflows/static-analysis.yaml @@ -62,7 +62,7 @@ jobs: cache-dependency-path: "**/package-lock.json" - name: Install mintlify-scrape - run: npm install -g @mintlify/scraping@4.0.110 + run: npm install -g @mintlify/scraping@4.0.112 - name: Run pre-commit run: | From 341a0cd7b8a871c07393ed15c28949a165e3a60f Mon Sep 17 00:00:00 2001 From: Jeff Hale Date: Thu, 6 Feb 2025 12:26:34 -0500 Subject: [PATCH 13/13] Update scripts/generate_mintlify_openapi_docs.py --- scripts/generate_mintlify_openapi_docs.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/scripts/generate_mintlify_openapi_docs.py b/scripts/generate_mintlify_openapi_docs.py index cd8d65f21595..cc1e81d4864d 100755 --- a/scripts/generate_mintlify_openapi_docs.py +++ b/scripts/generate_mintlify_openapi_docs.py @@ -8,7 +8,7 @@ from prefect.server.api.server import create_app -MINTLIFY_SCRAPE = ["npx", "--yes", "@mintlify/scraping@4.0.110"] +MINTLIFY_SCRAPE = ["npx", "--yes", "@mintlify/scraping@4.0.112"] def docs_path() -> Path: