Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Add Prefect Cloud Quickstart tutorial #8227

Merged
merged 9 commits into from
Jan 26, 2023
Merged

Add Prefect Cloud Quickstart tutorial #8227

merged 9 commits into from
Jan 26, 2023

Conversation

tpdorsey
Copy link
Contributor

@tpdorsey tpdorsey commented Jan 23, 2023 •
edited
Loading

Adds a new Prefect Cloud Quickstart page, adapting signup, login, and first flow run from previous content into a standalone page.

Moves Prefect Cloud deployment steps to a new tutorial.

  • Moves Prefect Cloud overview pages up to the top of the Prefect UI & Prefect Cloud navigation.
  • Adds a Concepts section with discrete pages for creating API keys and configuring execution environments.
  • Adds notes and a CTA of sorts to the Deployments and Storage & Infra tutorials, providing tips/encouragement for running the tutorials with Prefect Cloud as the backend.
  • Minor fixes to links, prompts, and such.

Example

Preview

Checklist

  • This pull request references any related issue by including "closes <link to issue>"
    • If no issue exists and your change is not a small fix, please create an issue first.
  • This pull request includes tests or only affects documentation.
  • This pull request includes a label categorizing the change e.g. fix, feature, enhancement

@tpdorsey tpdorsey added docs DONT MERGE This PR shouldn't be merged (yet) labels Jan 23, 2023
@netlify
Copy link

netlify bot commented Jan 23, 2023 •
edited
Loading

✅ Deploy Preview for prefect-orion ready!

Name Link
🔨 Latest commit d71b434
🔍 Latest deploy log https://app.netlify.com/sites/prefect-orion/deploys/63d1b598cdb5f10008a1eb97
😎 Deploy Preview https://deploy-preview-8227--prefect-orion.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site settings.

@tpdorsey
Copy link
Contributor Author

There are still many broken things to fix here. Expect broken links and incomplete content outside of the new Quickstart page.

@tpdorsey tpdorsey removed the DONT MERGE This PR shouldn't be merged (yet) label Jan 25, 2023
@tpdorsey tpdorsey marked this pull request as ready for review January 25, 2023 16:25
billpalombi
billpalombi approved these changes Jan 25, 2023
View reviewed changes
Copy link
Contributor

@billpalombi billpalombi left a comment

Choose a reason for hiding this comment

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

Looks great to me overall. I left a couple of small recomendations.

docs/tutorials/deployments.md Outdated Show resolved Hide resolved
docs/ui/cloud-quickstart.md Outdated Show resolved Hide resolved
Terrence Dorsey and others added 2 commits January 25, 2023 13:55
discdiver
discdiver reviewed Jan 25, 2023
View reviewed changes
docs/ui/cloud-quickstart.md
In your local environment, where you configured the previous steps, create a file named `quickstart_flow.py` with the following contents:

```python
from prefect import flow, get_run_logger
Copy link
Contributor

Choose a reason for hiding this comment

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

Minor, but what do you think of not using get_run_logger and just passing log_prints=True and then print(...). You'd have to rerun and re-screeenshot, so maybe not worth it. I just like keeping the number of imports and amount of code as absolutely basic as possible to show folks they don't need new imports or to instantiate anything and cal its method.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I really want to show the logging in this example

discdiver
discdiver reviewed Jan 25, 2023
View reviewed changes
Copy link
Contributor

@discdiver discdiver left a comment

Choose a reason for hiding this comment

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

one suggested code change

docs/ui/cloud-quickstart.md Show resolved Hide resolved
docs/ui/cloud-quickstart.md Show resolved Hide resolved
docs/ui/cloud-quickstart.md Show resolved Hide resolved
discdiver
discdiver reviewed Jan 25, 2023
View reviewed changes
Copy link
Contributor

@discdiver discdiver left a comment

Choose a reason for hiding this comment

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

If we are assuming the user might need to make a workspace, maybe we should just make step 1 sign up

Second thought: I might make a #4, create a flow and #5 then be run a flow.

so:

  1. Sign up
  2. Make a workspace
  3. Log in from your machine
  4. Make a flow
  5. Run a flow

@tpdorsey
Copy link
Contributor Author

@discdiver the intent was for this to be the CTA after creating a workspace. If that's confusing then we need to work out that ux

@discdiver
Copy link
Contributor

This at the top of the page?
Screenshot 2023-01-25 at 4 56 08 PM

Just saw should be "workspace" rather than "workspaces" btw

@discdiver
Copy link
Contributor

I wonder if worth calling out install prefect as a step, too. I'm taking you up on idea to make some content - a video I'm scripting now. :)

discdiver
discdiver approved these changes Jan 25, 2023
View reviewed changes
Copy link
Contributor

@discdiver discdiver left a comment •
edited
Loading

Choose a reason for hiding this comment

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

fine by me to import the logger. log_prints shows them too and that's what the demo in the UI on the flow_runs shows for a first time user, fwiw.

@tpdorsey tpdorsey merged commit 831f8a0 into main Jan 26, 2023
@tpdorsey tpdorsey deleted the cld-quickstart branch January 26, 2023 01:27
ddelange added a commit to ddelange/prefect that referenced this pull request Jan 26, 2023
@ddelange
Merge branch 'main' of https://github.com/prefecthq/prefect into sigt…
8621870 
…erm-testing

* 'main' of https://github.com/prefecthq/prefect: (77 commits)
  Update roles and permissions in documentation (PrefectHQ#8263)
  Add Prefect Cloud Quickstart tutorial (PrefectHQ#8227)
  Remove needless log
  Update comment for consistency
  Reorder migrations for clarity
  Refactor cancellation cleanup service
  Uses canonical `CANCELLING` states for run cancellations (PrefectHQ#8245)
  Add cancellation cleanup service (PrefectHQ#8128)
  Improve engine shutdown handling of SIGTERM (PrefectHQ#8127)
  Create a `CANCELLING` state type (PrefectHQ#7794)
  Update KubernetesJob options (PrefectHQ#8261)
  Small work pools UI updates (PrefectHQ#8257)
  Removes migration logic (PrefectHQ#8255)
  Consolidate multi-arch docker builds (PrefectHQ#7902)
  Include nested `pydantic.BaseModel` secret fields in blocks' schema (PrefectHQ#8246)
  Improve contributing documentation with venv instructions (PrefectHQ#8247)
  Update Python tests to use a single test matrix for both databases (PrefectHQ#8171)
  Adds migration logic for work pools (PrefectHQ#8214)
  Add `project_urls` to `setup.py` (PrefectHQ#8224)
  Add `is_schedule_active` to client `Deployment` class (PrefectHQ#7430)
  ...
github-actions bot pushed a commit that referenced this pull request Jan 26, 2023
@billpalombi @github-actions
Add Prefect Cloud Quickstart tutorial (#8227)
daecaee 
Co-authored-by: Bill Palombi <bill@prefect.io>
github-actions bot pushed a commit that referenced this pull request Jan 26, 2023
@billpalombi @madkinsz
Add Prefect Cloud Quickstart tutorial (#8227)
21b8773 
Co-authored-by: Bill Palombi <bill@prefect.io>
@tpdorsey tpdorsey mentioned this pull request Jan 27, 2023
Merged
3 tasks
@zanieb zanieb mentioned this pull request Feb 3, 2023
Merged
3 tasks
zanieb added a commit that referenced this pull request Feb 3, 2023
@zanieb @billpalombi
Add Prefect Cloud Quickstart tutorial (#8227)
abf693e 
Co-authored-by: Bill Palombi <bill@prefect.io>
zanieb added a commit that referenced this pull request Feb 3, 2023
@zanieb @billpalombi
Add Prefect Cloud Quickstart tutorial (#8227)
e74050e 
Co-authored-by: Bill Palombi <bill@prefect.io>
@zanieb zanieb mentioned this pull request Feb 6, 2023
Merged
zanieb pushed a commit that referenced this pull request Feb 6, 2023
@billpalombi @zanieb
Add Prefect Cloud Quickstart tutorial (#8227)
f90b96d 
Co-authored-by: Bill Palombi <bill@prefect.io>
zanieb pushed a commit that referenced this pull request Feb 6, 2023
@billpalombi @zanieb
Add Prefect Cloud Quickstart tutorial (#8227)
11421a1 
Co-authored-by: Bill Palombi <bill@prefect.io>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@discdiver discdiver discdiver approved these changes

@billpalombi billpalombi billpalombi approved these changes

@abrookins abrookins Awaiting requested review from abrookins

@zhen0 zhen0 Awaiting requested review from zhen0

Assignees
No one assigned
Labels
docs
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@tpdorsey @discdiver @billpalombi