docs: Update guide on PPE pricing model - #1064
Conversation
szaganek
added
documentation
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## master #1064 +/- ##
=======================================
Coverage 91.89% 91.89%
=======================================
Files 51 51
Lines 3232 3232
=======================================
Hits 2970 2970
Misses 262 262
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Harness. 🚀 New features to boost your workflow:
|
vdusek
left a comment
vdusek
left a comment
There was a problem hiding this comment.
Two comments for consideration; otherwise LGTM.
|
|
||
| <RunnableCodeBlock className="language-python" language="python"> | ||
| {ConditionalActorChargeSource} | ||
| </RunnableCodeBlock> |
There was a problem hiding this comment.
Shouldn't there be some conclusion?
There was a problem hiding this comment.
About that conclusion, where does it come from? We don't use it anywhere in the docs except for here. Frankly, it's not really useful. Is it some legacy?
There was a problem hiding this comment.
IIRC, it was already part of the existing content when I joined, so I just followed the established structure.
Removing it from a single page and leaving it on the others is inconsistent. If we decide that these sections are unnecessary, we should apply that change across the whole documentation.
As for whether they should be there at all, I'm in favor of keeping them. IMO learning-oriented content benefits from an ending that summarizes the key takeaways or points readers toward what to explore next.
There was a problem hiding this comment.
I brought it up at the docs meeting, we discussed it, and decided that we should get rid of the Conclusion section everywhere. The main reasons are consistency with the rest of the docs plus these sections don't add much value in the current form. These docs aren't a course to follow, they aren't read like a book.
I'll review all these sections and move some of the content to the introductions, where it makes sense.
There was a problem hiding this comment.
Okay, please leave it in this PR for now and open a follow-up PR to remove them, since it's unrelated to these changes.
vdusek
left a comment
vdusek
left a comment
There was a problem hiding this comment.
let's resolve the conclusion thing first
- Removes outdated info on Actors running indefinitely. - Restructures the whole guide. - Adds missing sections so both SDKs can mirror each other better ([Python PR](apify/apify-sdk-python#1064)) Related to the recent updates to platform docs [#2770](apify/apify-docs#2770).
3 participants
Related to the recent updates to platform docs #2770.