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

Update formatting of Prefect History timeline #17114

Merged
merged 1 commit into from
Feb 12, 2025
Merged

Update formatting of Prefect History timeline #17114

merged 1 commit into from
Feb 12, 2025

Conversation

discdiver
Copy link
Contributor

Updates formatting of Prefect History on the index page in the docs to save space - @thomas-te's eagle eye suggestion.

Also removes a mint.json page link for a non-existent page.

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.
  • 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.

@discdiver
Copy link
Contributor Author

Static analysis failure isn't related to any changes in this PR.

Copy link
Contributor

@daniel-prefect daniel-prefect left a comment

Choose a reason for hiding this comment

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

I'm fine with the formatting changes, but I'm not sure that the timelines are accurate based on PyPI release history. Can you verify with @thomas-te @cicdw and @aaazzam on these?

<Steps>
<Step title="2018-2021">
Our story begins with Prefect 1.0, in which we introduced the idea that workflow orchestration should be Pythonic.
**2018-2021:** Our story begins with Prefect 1.0, in which we introduced the idea that workflow orchestration should be Pythonic.
Copy link
Contributor

Choose a reason for hiding this comment

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

Prefect 1.0 was released in 2022 based on the PyPI release history. https://pypi.org/project/prefect/1.0.0/

Suggested change
**2018-2021:** Our story begins with Prefect 1.0, in which we introduced the idea that workflow orchestration should be Pythonic.
**2018-2022:** Our story begins with Prefect 1.0, in which we introduced the idea that workflow orchestration should be Pythonic.

Copy link
Member

Choose a reason for hiding this comment

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

Yea this is a question of narrative accuracy vs. technical precision: you are right that 1.0 was released in 2022, but it was basically a stamp on the culmination of 0.x work since 2018.

I think for the purposes of this timeline we're trying to emphasize Prefect's innovation not the specific release, so I personally vote to remove the 1.0 precision and simply say "Our story begins in 2018, when we introduced the idea that workflow orchestration should be Pythonic."

<Step title="2022-2024">
Prefect's 2.0 release became inevitable once we recognized that real-world workflows don't always fit into neat, pre-planned DAG structures: sometimes you need to update a job definition based on runtime information, for example by skipping a branch of your workflow.

**2022-2024:** Prefect's 2.0 release became inevitable once we recognized that real-world workflows don't always fit into neat, pre-planned DAG structures: sometimes you need to update a job definition based on runtime information, for example by skipping a branch of your workflow.
Copy link
Contributor

Choose a reason for hiding this comment

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

Prefect 2.0 was also released in 2022. https://pypi.org/project/prefect/2.0.0/

Suggested change
**2022-2024:** Prefect's 2.0 release became inevitable once we recognized that real-world workflows don't always fit into neat, pre-planned DAG structures: sometimes you need to update a job definition based on runtime information, for example by skipping a branch of your workflow.
**2022:** Prefect's 2.0 release became inevitable once we recognized that real-world workflows don't always fit into neat, pre-planned DAG structures: sometimes you need to update a job definition based on runtime information, for example by skipping a branch of your workflow.

Copy link
Contributor

@daniel-prefect daniel-prefect left a comment

Choose a reason for hiding this comment

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

Sorry, I got the 3.0 release date wrong in my earlier comment, but I think the suggestions still stand.

<Step title="2024 and beyond">
With our release of Prefect 3.0 in 2024, we fully embraced these dynamic patterns by open-sourcing our events and automations backend, allowing users to natively represent event-driven workflows and gain additional observability into their execution.

**2024 and beyond:** With our release of Prefect 3.0 in 2024, we fully embraced these dynamic patterns by open-sourcing our events and automations backend, allowing users to natively represent event-driven workflows and gain additional observability into their execution.
Copy link
Contributor

Choose a reason for hiding this comment

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

Even though the release year for 3.0 is accurate, I wonder if we should say 2023-present to avoid any gaps with the previous entry in the timeline.

Suggested change
**2024 and beyond:** With our release of Prefect 3.0 in 2024, we fully embraced these dynamic patterns by open-sourcing our events and automations backend, allowing users to natively represent event-driven workflows and gain additional observability into their execution.
**2023-present:** With our release of Prefect 3.0 in 2024, we fully embraced these dynamic patterns by open-sourcing our events and automations backend, allowing users to natively represent event-driven workflows and gain additional observability into their execution.

@discdiver discdiver merged commit ee9cfca into main Feb 12, 2025
10 of 11 checks passed
@discdiver discdiver deleted the stepping branch February 12, 2025 18:30
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.

3 participants