https://prefect.io
Join Slack
:wave: folks! I feel like Prefect's docs could use some improvement. `Constructive criticism` is my...
# ask-community
a
šŸ‘‹ folks! I feel like Prefect's docs could use some improvement. 
Constructive criticism
is my love language, could folks reply to this thread with where you'd like to see them improve the most? Even if you're out of ideas and it's a simple "I once tried to figure this out and it was wayyy to complicated" then that counts!
šŸ¦œ 3
šŸ™Œ 3
upvote 3
j
Create a document that explains what "ephemeral servers" are and why I keep getting errors about them.
šŸ«” 1
šŸ‘» 1
šŸ™ 3
Sometimes my flows seem to change working directory and/or the source code gets copied to my working directory. What's going on?
I spent a lot of time trying to figure out logging (I think there's a bug -- GH-15370) but definitely could use more docs there.
Humans should look at all tables -- some of them are badly formatted. For example, see attached. If they need to be scrollable, the headers should be "sticky" and the scrolling should be easy to accomplish (say with the arrow keys or grab and drag) without having to be all the way to the bottom or the right.
yess 1
What's new on docs home page should make it easy to find the changelog
upvote 2
b
My vote would be for some quickstarts or cheatsheets. One page, end to end, and something works, talking through why, with links to the docs to learn more. Remove the need to jump around (create a flow, now over here to deploy, now over here to do X)..... I recently felt like I was bouncing around the docs to connect ideas. I was able to get up and running, but the idea would be something that is cookbook-style and task specific, with recipes that vary in terms of complexity or assumed knowledge (e.g. how to get your first prefect flow onto Cloud and scheduled with managed services)
yess 4
w
True about what's news, would be nice to have more info about what's getting in. Currently what I do is to check Github releases directly because is more reliable. Also I really like the resource "big data", I would love to see the content on that page to be more extensive discussed. Also, would be great if the docs could have more guides like that covering others topics covering and Prefect features. https://docs.prefect.io/3.0/resources/big-data
v
ā€¢ It's very hard to find all the settings and what they mean ā€¢ Community resources and github issues and old documentation sites constantly confuse Prefect 2.x and 3.x ā€¢ the SDK docs are ugly and not well linked to the main docs ā€¢ there are no good benchmarks to help understand what to expect
šŸ‘ 1
j
Everything related to prefect_test_harness -- what are the features of this? How do I diagnose why it keeps crashing? Testing best practices?
Trying to understand docs related to prefect logging - Looking here: https://docs.prefect.io/3.0/develop/settings-ref#loggingtoapisettings "batch size" is "The number of logs to batch before sending to the API." I tried setting this to 1 to make no batching, send each log message to the api right away (I am trying to troubleshoot a logging issue) This leads to an error:
Copy code
Value error, `PREFECT_LOGGING_TO_API_MAX_LOG_SIZE` cannot be larger than `PREFECT_LOGGING_TO_API_BATCH_SIZE`
I'm a bit confused... Why should the maximum size of one log entry be smaller than the number of logs in one batch? Maybe these are both in bytes rather than counts?
5 Views
Open in Slack
PreviousNext
Powered by

Prefect Community

Bring your towel and join one of the fastest growing data communities. Welcome to our second-generation open source orchestration platform, a completely rethought approach to dataflow automation.

Powered by