Update quickstart guide for usability #13562
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Specifies the title for the first script to align with the title from the second version of it later in the document.
The first iteration of the script varied a bit from the second iteration, but the highlighted lines in the second iteration suggested only two lines had changed. This isn't quite true - for example, the function signature of 'get_repo_info' changed to include two new arguments. When following along with the quickstart, this makes it look like a "patch", but after applying the same changes to my code, I obviously got a different result. This change aligns the first version with the second. A drawback is this makes this initial script longer, but: - It's still not a very long script anyway. - The "copy" button is still there, which I suspect most people use anyway. - Those following along can now actually just change 4 lines now and get the new result.
I didn't see a "Remove" button. I suspect this has changed, so I updated the instructions to toggle the button that disables the schedule.
|
I noticed a couple smaller things I'll list below. I can open separate issue(s) for these if these look relevant.
|
mitchnielsen
changed the title
billpalombi
reviewed
May 24, 2024
The first script doesn't need the prefect package imports (just a copy/pasta error). Co-authored-by: Bill Palombi <bill@prefect.io>
This was referenced May 28, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Adds a few changes to the quickstart guide for usability
based on my experience running through it for the first time.
I put each change in a separate commit with a commit message for
explanation, and so we can revert/adjust any of them as needed.
I put some other notes in a comment below.
Example
I tried to serve the docs locally, but got some errors:
For now, I'll just link to the markdown file on the branch:
https://github.com/PrefectHQ/prefect/blob/update-quickstart-guide/docs/getting-started/quickstart.md
Checklist
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 changesmaintenance,fix,feature,enhancement,docs.For documentation changes:
This pull request includes redirect settings innetlify.tomlfor files that are removed or renamed.