docs: rewrite GitHub integration page as step-by-step tutorial#2512
docs: rewrite GitHub integration page as step-by-step tutorial#2512marcel-rbro wants to merge 4 commits into
Conversation
…utorial Restructures the GitHub integration page into prerequisites, a numbered "Create an Actor from a GitHub repository" walkthrough that matches the current "Let's build a new Actor!" UI, and a written tutorial for opening a GitHub issue via Apify webhook + the GitHub REST API. Replaces the bare YouTube embed and refreshes the new-Actor and Integrations-tab screenshots. Closes #2492 Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
|
Also, it would be great to have preview to check it. :) Anyway, thanks! It looks good. |
|
Previews are broken atm (seems connected to npm > pnpm migraton) @vladfrangu is aware and working on fix |
|
I'm gonna piggy back off of this PR to test out the fixed previews, pls stand by and sorry in advance |
|
✅ Preview for this PR (commit |
|
One note -> let's probably remove the video? cc. @TC-MO |
|
Yes, I'll never say no to video pruning from docs :D how urgent this is? Can it wait until Marcel is back from off time next week, or should I take over to have this shipped this week? |
|
I guess it can wait, we are refactoring the UI in the meantime, so maybe it will need to be updated. :D |
…page Remove the inline reviewer question (manual webhook recipe confirmed as the current path) and drop the video walkthrough per reviewer request. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
|
I'm back now, applied the suggested changes. Also, @vladfrangu did I stand by for long enough and can I close this PR whenever ready? |
|
Oh yeah, testing was done and it works now! Feel free to proceed as normal whichever way that is |
Match the convention in sources/platform/integrations/programming/ (api.md does not use the disclaimer either) per review feedback. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
TC-MO
left a comment
There was a problem hiding this comment.
Thanks, substantial improvement over the original.
A few changes to address before merging.
Non-blocking tangent (not for this PR):
We should rethink our use of click more broadly across the docs. Either prefer select outright or formalize a click (buttons) vs select (list choices) distinction.
- Move Prerequisites under "Create an Actor from a GitHub repository" - Clarify the API dropdown / "API endpoints" selection in Console - Replace "tell GitHub" with "specify" to avoid anthropomorphizing - Use input-induced failure as the test example (abort fires ACTOR.RUN.ABORTED, not ACTOR.RUN.FAILED) Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
Closes #2492
Summary
Rewrites
sources/platform/integrations/programming/github.md:ACTOR.RUN.FAILEDHTTP webhook on the Actor, set the headers/payload templates to callPOST /repos/{owner}/{repo}/issues, save and test. Kept the original video as a "Video walkthrough" subsection.apify-git-repository.png(the new-Actor page) andintegrations-tab.png(the Add integration page; this image is also reused byslack.mdandwebhooks/index.md).apify-git-provider-select.png(the provider-picker modal no longer exists).<ThirdPartyDisclaimer />, no bold one-liner or---rule), matching recent integration pages (Pipedream, Snowflake, Manus, viaSocket, x402).Reviewer question
There's an inline MDX comment in the Build automatically on every push section asking whether the native "Link a Git repository" flow already wires up auto-builds (the panel's helper text suggests it does). If so, the manual GitHub webhook recipe currently in that section is the legacy path - please confirm and let me know whether to keep it as-is, replace it with a one-line note, or keep both with a clarifying intro.
Test plan
pnpm lint:mdpasses for the changed filevale "sources/platform/integrations/programming/github.md"reports 0 errors/platform/actors/development/deployment/continuous-integration,/platform/actors/development/deployment/source-types#private-repositories,/platform/integrations/webhooks/events,/platform/integrations/webhooks/actions)pnpm buildpasses (no broken links, frontmatter valid)integrations-tab.pngcorrectly🤖 Generated with Claude Code