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.

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

Add OSS to the quickstart #14093

Merged
merged 42 commits into from
Jun 19, 2024
Merged

Add OSS to the quickstart #14093

merged 42 commits into from
Jun 19, 2024

Conversation

djsauble
Copy link
Contributor

@djsauble djsauble commented Jun 17, 2024

The quickstart is cloud-centric. Because OSS is a popular path for first-time users, let's update the quickstart to give people the option of whether they want to go down the cloud or OSS path.

Closes #14029

This PR also converts the quickstart to ventilated prose to make future edits easier to review.

Example

Instead of creating separate quickstarts for cloud and OSS, let's add tabs to the existing quickstart to let people easily toggle between these paths. This approach doesn't require users to know in advance which path they want to go down, and it makes it easy to compare equivalent cloud and OSS code.

<Tabs>
  <Tab title="Cloud">
Cloud instructions
  </Tab>
  <Tab title="OSS">
OSS instructions
  </Tab>
</Tabs>

Checklist

  • This pull request includes a label categorizing the change e.g. maintenance, fix, feature, enhancement, docs.
  • This pull request references any related issue by including "closes <link to issue>"
  • 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 adds functions or classes, it includes helpful docstrings.

Preview

https://prefect-bd373955-add_oss_to_the_quickstart.mintlify.app/3.0rc/get-started/quickstart

@djsauble djsauble marked this pull request as ready for review June 18, 2024 18:51
@djsauble djsauble requested a review from a team as a code owner June 18, 2024 18:51
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.

Thank you! One question about work pools we want to show and minor suggestions.

docs/3.0rc/get-started/quickstart.mdx Outdated Show resolved Hide resolved
docs/3.0rc/get-started/quickstart.mdx Outdated Show resolved Hide resolved
docs/3.0rc/get-started/quickstart.mdx Outdated Show resolved Hide resolved
djsauble and others added 3 commits June 18, 2024 12:49
Co-authored-by: Jeff Hale <discdiver@users.noreply.github.com>
Co-authored-by: Jeff Hale <discdiver@users.noreply.github.com>
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.

This is great! I made few suggestions but I don't hold them very strongly.

docs/3.0rc/get-started/quickstart.mdx Outdated Show resolved Hide resolved
docs/3.0rc/get-started/quickstart.mdx Outdated Show resolved Hide resolved
docs/3.0rc/get-started/quickstart.mdx Outdated Show resolved Hide resolved
docs/3.0rc/get-started/quickstart.mdx Outdated Show resolved Hide resolved
docs/3.0rc/get-started/quickstart.mdx Outdated Show resolved Hide resolved
@djsauble djsauble merged commit a003e22 into main Jun 19, 2024
4 checks passed
@djsauble djsauble deleted the add_oss_to_the_quickstart branch June 19, 2024 02:04
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Update the Quickstart to reflect OSS options
4 participants