Skip to content

Commit

Permalink
Move concepts and cloud pages to guides and reorganize (#10328)
Browse files Browse the repository at this point in the history
Co-authored-by: Bill Palombi <[email protected]>
  • Loading branch information
discdiver and billpalombi authored Jul 31, 2023
1 parent 2c5f2c1 commit bc93572
Show file tree
Hide file tree
Showing 15 changed files with 102 additions and 42 deletions.
2 changes: 1 addition & 1 deletion docs/cloud/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -73,7 +73,7 @@ When you first log into Prefect Cloud and create your workspace, it will most li

## Events

Prefect Cloud allows you to see your [events](https://docs.prefect.io/2.10.13/cloud/events/).
Prefect Cloud allows you to see your [events](/cloud/events/).
![Prefect UI](/img/ui/event-feed.png)


Expand Down
2 changes: 1 addition & 1 deletion docs/cloud/automations.md → docs/concepts/automations.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ The button next to the toggle provides commands to copy the automation ID, edit

Select the name of an automation to view **Details** about it and relevant **Events**.

![Viewing details and events that triggered an automation in Prefect Cloud.](/img/ui/automation-detail-and-events.png)
![Viewing details and events that triggered an automation in Prefect Cloud.](/img/ui/automations-detail-tab.png)

## Create an automation

Expand Down
2 changes: 1 addition & 1 deletion docs/cloud/events.md → docs/concepts/events.md
Original file line number Diff line number Diff line change
Expand Up @@ -67,7 +67,7 @@ def some_function(name: str="kiki") -> None:
some_function()
```

Prefect Cloud offers [programmable webhooks](/cloud/webhooks/) to recieve HTTP requests from other systems and translate them into events within your workspace. Webhooks can emit [pre-defined static events](/cloud/webhooks/#static-webhook-events), dynamic events that [use portions of the incoming HTTP request](/cloud/webhooks/#dynamic-webhook-events), or events derived from [CloudEvents](http://localhost:8000/cloud/webhooks/#accepting-cloudevents).
Prefect Cloud offers [programmable webhooks](/guides/webhooks/) to receive HTTP requests from other systems and translate them into events within your workspace. Webhooks can emit [pre-defined static events](/guides/webhooks/#static-webhook-events), dynamic events that [use portions of the incoming HTTP request](/guides/webhooks/#dynamic-webhook-events), or events derived from [CloudEvents](/guides/webhooks/#accepting-cloudevents).

Events emitted from any source will appear in the [event feed](/ui/events/), where you can visualize activity in context and configure [automations](/ui/automations/) to react to the presence or absence of it in the future.

Expand Down
4 changes: 3 additions & 1 deletion docs/concepts/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,5 +37,7 @@ search:
| __[Infrastructure](/concepts/infrastructure)__ | [Blocks](/concepts/blocks/) that specify infrastructure for flow runs created by the deployment. |
| __[Schedules](/concepts/schedules)__ | Tell the Prefect API how to create new flow runs for you automatically on a specified cadence. |
| __[Logging](/concepts/logs)__ | Log a variety of useful information about your flow and task runs on the server. |
| __[Events](/concepts/events)__ | Observe activity across your stack. |
| __[Automations](/concepts/automations)__ | Configure actions that Prefect executes automatically based on trigger conditions. |

Features specific to [Prefect Cloud](/cloud/) are in their own subheading.
Many features specific to [Prefect Cloud](/cloud/) are in their own subheading.
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@ tags:
- Cloud Run
- AWS ECS
- Azure Container Instance
- ACI
search:
boost: 2
---
Expand Down Expand Up @@ -61,13 +62,11 @@ In this guide you will:
2. Click on "Access control (IAM)" and then "Role assignments".
3. Search for the app registration and select it. Give it a role that has sufficient privileges to create, run, and delete ACI container groups.



## Work Pool Configuration
## Work pool configuration

Our push work pool will store information about what type of infrastructure we're running on, what default values to provide to compute jobs, and other important execution environment parameters. Because our push work pool needs to integrate securely with your serverless infrastructure, we need to start by storing our credentials in Prefect Cloud, which we'll do by making a block.

### Creating a Credentials Block
### Creating a Credentials block

=== "Google Cloud Run"

Expand Down Expand Up @@ -95,7 +94,7 @@ Our push work pool will store information about what type of infrastructure we'r

Provide any other optional information and create your block.

### Create Push Work Pool
### Create push work pool

Now navigate to work pools and click create to start configuring your push work pool by selecting a push option in the infrastructure type step.

Expand Down Expand Up @@ -124,7 +123,7 @@ Deployment details are described in the deployments [concept section](/concepts/
Deploying your flow to the `my-push-pool` work pool will ensure that runs that are ready for execution will be submitted immediately, without the need for a worker to poll for them.

## Putting it all Together
## Putting it all together

With your deployment created, navigate to its detail page and create a new flow run. You'll see the flow start running without ever having to poll the work pool, because Prefect Cloud securely connected to your serverless infrastructure, created a job, ran the job, and began reporting on its execution.

Expand Down
1 change: 0 additions & 1 deletion docs/host/index.md → docs/guides/host.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
---
description: Hosting Prefect Sever
icon: octicons/server-24
tags:
- UI
- dashboard
Expand Down
36 changes: 27 additions & 9 deletions docs/guides/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,19 +5,37 @@ title: Guides
tags:
- guides
- how to
hide:
- toc
search:
boost: 2
---

- Learn how Prefect makes [testing your workflows a breeze](/guides/testing/).
- See how to [parallelize your code with Dask and Ray](/guides/dask-ray-task-runners/).
- Learn the basics of [troubleshooting Prefect](/guides/troubleshooting/).
- Learn how to use [Docker with your Deployments](/guides/deployment/docker/).
- See how to [deploy your workflows with Azure Container Instances](/guides/deployment/aci/).
- Check out many common workflows with [Prefect Recipes](../recipes/recipes/).
- Learn how to migrate from Prefect 1 to Prefect 2 with the [Migration Guide](/guides/migration-guide/).
- Execute code in response to state changes with [state change hooks](/guides/state-change-hooks/).
- Execute serverless flows without running a worker using [Push Work Pools](/guides/push-work-pools/).
# Guides

This section of the documentation contains guides for common workflows and use cases.

| Keyword | Description |
| -------------------------------------------------------- | -------------------------------------------------------------------------------------------------- |
| [Storage](/guides/deployment/storage-guide/) | Store your code for deployed flows. |
| [Docker](/guides/deployment/docker/) | Deploy flows with Docker containers. |
| [Kubernetes](/guides/deployment/helm-worker/) | Deploy flows on Kubernetes. |
| [Push Work Pools](/guides/deployment/push-work-pools/) | Execute flows on serverless infrastructure like AWS ECS, Azure Container Instances, or Google Cloud Run without a worker. |
| [ECS](https://prefecthq.github.io/prefect-aws/#using-prefect-with-aws-ecs) | Run flows on AWS ECS. |
| [Azure Container Instances](/guides/deployment/aci/) | Deploy flows to Azure Container Instances. |
| [Custom Workers](/guides/deployment/developing-a-new-worker-type/) | Develop your own worker type. |
| [Profiles & Settings](/guides/settings/) | Configure Prefect and save your settings. |
| [Logging](/guides/logs/) | Configure Prefect's logger and aggregate logs from other tools. |
| [Testing](/guides/testing/) | Easily test your workflows. |
| [Troubleshooting](/guides/troubleshooting/) | Identify and resolve common issues with Prefect. |
| [Runtime context](/guides/runtime-context/) | Enable a flow to access metadata about itself and its context when it runs. |
| [Variables](/guides/variables/) | Store and retrieve configuration data. |
| [Webhooks](/guides/webhooks/) | Receive, observe, and react to events from other systems. |
| [State Change Hooks](/guides/state-change-hooks/) | Execute code in response to state changes. |
| [Dask and Ray](/guides/dask-ray-task-runners/) | Scale your flows with parallel computing frameworks. |
| [Hosting](/guides/host/) | Host your own Prefect Server. |
| [Migration Guide](/guides/migration-guide/) | Migrate from Prefect 1 to Prefect 2. |
| [Prefect Recipes](../recipes/recipes/) | Common, extensible examples for setting up Prefect. |

!!! tip "Need help?"
Get your questions answered with a Prefect product advocate by [Booking A Rubber Duck](https://calendly.com/prefect-experts/prefect-product-advocates)!
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
4 changes: 2 additions & 2 deletions mkdocs.insiders.yml
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,6 @@ plugins:
- cdn.amplitude.com/*
social:
cards: !ENV [DOC_PROD, True]
cards_color:
fill: "#115AF4"
cards_layout_options:
background_color: "#115AF4"
typeset:
38 changes: 20 additions & 18 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -75,6 +75,9 @@ theme:
toggle:
icon: material/weather-night
name: Switch to light mode
validation:
absolute_links: ignore
unrecognized_links: ignore
plugins:
mike:
canonical_version: latest
Expand Down Expand Up @@ -148,10 +151,7 @@ nav:
- Artifacts: concepts/artifacts.md
- States: concepts/states.md
- Blocks: concepts/blocks.md
- Variables: concepts/variables.md
- Task Runners: concepts/task-runners.md
- Runtime Context: concepts/runtime-context.md
- Profiles & Configuration: concepts/settings.md
- Deploy:
- Deployments: concepts/deployments.md
- Deployment Management: concepts/deployments-ux.md
Expand All @@ -160,7 +160,8 @@ nav:
- Filesystems: concepts/filesystems.md
- Infrastructure: concepts/infrastructure.md
- Schedules: concepts/schedules.md
- Logging: concepts/logs.md
- Events: concepts/events.md
- Automations: concepts/automations.md
- Cloud:
- cloud/index.md
- Workspaces: cloud/workspaces.md
Expand All @@ -172,29 +173,30 @@ nav:
- Service Accounts: cloud/users/service-accounts.md
- Single Sign-on (SSO): cloud/users/sso.md
- Audit Log: cloud/users/audit-log.md
- Events: cloud/events.md
- Webhooks: cloud/webhooks.md
- Automations: cloud/automations.md
- API Rate Limits: cloud/rate-limits.md
- Connecting & Troubleshooting: cloud/connecting.md
- Host:
- host/index.md
- Guides:
- guides/index.md
- Testing: guides/testing.md
- Dask & Ray: guides/dask-ray-task-runners.md
- Troubleshooting: guides/troubleshooting.md
- Deployment:
- Storage: guides/deployment/storage-guide.md
- Docker: guides/deployment/docker.md
- Azure Container Instance: guides/deployment/aci.md
- Kubernetes Worker with Helm: guides/deployment/helm-worker.md
- Developing a New Worker Type: guides/deployment/developing-a-new-worker-type.md
- Running flow on AWS ECS: https://prefecthq.github.io/prefect-aws/#using-prefect-with-aws-ecs
- Recipes: recipes/recipes.md
- Migration Guide: guides/migration-guide.md
- Serverless Push Work Pools: guides/deployment/push-work-pools.md
- Run a flow on AWS ECS: https://prefecthq.github.io/prefect-aws/#using-prefect-with-aws-ecs
- Azure Container Instance: guides/deployment/aci.md
- Custom Workers: guides/deployment/developing-a-new-worker-type.md
- Profiles & Configuration: guides/settings.md
- Logging: guides/logs.md
- Testing: guides/testing.md
- Troubleshooting: guides/troubleshooting.md
- Runtime Context: guides/runtime-context.md
- Variables: guides/variables.md
- Webhooks: guides/webhooks.md
- State Change Hooks: guides/state-change-hooks.md
- Push Work Pools: guides/push-work-pools.md
- Dask & Ray: guides/dask-ray-task-runners.md
- Hosting: guides/host.md
- Migration: guides/migration-guide.md
- Recipes: recipes/recipes.md
- Integrations:
- integrations/index.md
- Using Integrations: integrations/usage.md
Expand Down
44 changes: 42 additions & 2 deletions netlify.toml
Original file line number Diff line number Diff line change
Expand Up @@ -375,8 +375,48 @@ to = "/api-ref/prefect/deployments-ux/"
status = 301

[[redirects]]
from = "/guides/cloud-run-push-work-pools.md"
to = "/guides/push-work-pools.md"
from = "/guides/cloud-run-push-work-pools/"
to = "/guides/push-work-pools/"
status = 301

[[redirects]]
from = "/concepts/logs/"
to = "/guides/logs/"
status = 301

[[redirects]]
from = "/concepts/runtime-context/"
to = "/guides/runtime-context/"
status = 301

[[redirects]]
from = "/concepts/settings/"
to = "/guides/settings/"
status = 301

[[redirects]]
from = "/concepts/variables/"
to = "/guides/variables/"
status = 301

[[redirects]]
from = "/cloud/webhooks/"
to = "/guides/webhooks/"
status = 301

[[redirects]]
from = "/cloud/events/"
to = "/concepts/events/"
status = 301

[[redirects]]
from = "/cloud/automations/"
to = "/concepts/automations/"
status = 301

[[redirects]]
from = "/host/"
to = "/guides/host/"
status = 301

[[headers]]
Expand Down

0 comments on commit bc93572

Please sign in to comment.