-
Notifications
You must be signed in to change notification settings - Fork 129
docs: Add synthetic start event #1915
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
Conversation
Preview for this PR was built for commit |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
In general looks good, I added a couple of comments. @mnmkng also please have a look, if you want to add any story-telling to this, and motivate better why they should use this.
@patrikbraborec other things I think that are worth mentioning
- you are more attractive to users that need to use your Actor in more API like way (shorter runs)
- and this is especially important for agentic users in the boom of AI economy
- and also important to large users, for which the costs of high actors starts are prohibitive and they wouldn't use your actor at all if actor start is too high
This being said, I suggest let's tweak what we can, and we can always polish it further after feeback from @mnmkng , I don't want to condition the release on perfect wording here. Hence, approving.
Co-authored-by: Matej Hamas <matej.hamas@apify.com>
Co-authored-by: Matej Hamas <matej.hamas@apify.com>
Preview for this PR was built for commit |
1 similar comment
Preview for this PR was built for commit |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I miss the part where we start pushing existing developers to replace their existing events that act as actor-start
with this one.
Co-authored-by: Michał Olender <92638966+TC-MO@users.noreply.github.com>
Co-authored-by: Michał Olender <92638966+TC-MO@users.noreply.github.com>
Preview for this PR was built for commit |
1 similar comment
Preview for this PR was built for commit |
Thanks @souravjain540! I added a new section describing this situation. |
Preview for this PR was built for commit |
I wrote those docs some time ago, they don't seem to be included or considered. We don't have to block the release, but it would be nice to extend the guidance in a follow up PR. I know that the general way of writing docs is dry and straight to the point. But that's when you're writing developer docs for developers. This is monetization docs for developers. And since the vast majority of them knows nearly nothing about monetization, we have to be much more supportive IMO. We can't simply tell them "this is how you do it", but we also need to tell them the "why". |
@mnmkng the docs you've linked could maybe fit in with Actorization playbook within Academy? There is a whole section there about How Actor monetization work?. There we try to be a little lighter on the style of writing and be more about |
@mhamas, @mnmkng - thanks for the feedback, on the other hand I am little bit confused. Are you talking about this PR, or generally the updated PPE docs? The motivation for the first update of the PPE docs was mainly to add more code examples, best practices for developers, and also separate the Rental, PPR and PPE so we can add I think that what are you suggesting (explain why, etc.) is 100% true, and I added it to the document describing additional changes to the PPE docs. Feel free to check the docs. It will be just important to clear out, where this "why" guidelines should be as @TC-MO mentioned above. |
Personally, I don't care where it lives. I just want the devs to have it available and easy to find / hard to miss. 👍🏻 |
But maybe to make sure it's super clear, the document is called PPE guide, but it really isn't. It's just a a guide for the new actor start. I thought people would extend it with other guides, but they ended up living elsewhere. So when I'm referencing it in this PR, I mean the specific actor start section that's in there. |
IMHO, let's get this out and then improve it with the next PR. |
I also propose to merge it. I added the improvements to follow ups: #1914 |
The docs for synthetic start event.
Related to the PR: https://github.com/apify/apify-core/pull/22673.