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

Update install instructions and simplify README #14135

Merged
merged 3 commits into from
Jun 19, 2024
Merged

Update install instructions and simplify README #14135

merged 3 commits into from
Jun 19, 2024

Conversation

discdiver
Copy link
Contributor

@discdiver discdiver commented Jun 19, 2024 •
edited
Loading

Simplifies README.

Updates install instructions in the docs for 3.0rc to make it apply to all RC versions.

Example

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 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 discdiver added the docs label Jun 19, 2024
@discdiver discdiver changed the title Update install instructions for 3.0rc to make it general and update README Update install instructions and simplify README Jun 19, 2024
@discdiver discdiver marked this pull request as ready for review June 19, 2024 00:11
@discdiver discdiver requested review from a team as code owners June 19, 2024 00:11
billpalombi
billpalombi approved these changes Jun 19, 2024
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.

A couple of thoughts for you. Thanks for doing this!

README.md
@@ -20,30 +20,30 @@

# Prefect

Prefect is an orchestration and observability platform for building, observing, and triaging workflows.
Prefect is an orchestration and observation platform for building and reacting to workflows.
Copy link
Contributor

Choose a reason for hiding this comment

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

Interesting, I don't think "observation" is wrong but it is unconventional. Unless you feel strongly about it, I'd srick with "observability"

README.md Outdated Show resolved Hide resolved
@discdiver @billpalombi
Update README.md
4d09cac 
Co-authored-by: Bill Palombi <bill@prefect.io>
@discdiver discdiver merged commit 347f69c into main Jun 19, 2024
3 checks passed
@discdiver discdiver deleted the readme branch June 19, 2024 00:32
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@billpalombi billpalombi billpalombi approved these changes

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

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