Skip to content

docs: integrate playbook into integrate with apify doc #1608

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

Merged
merged 9 commits into from
Jun 12, 2025

Conversation

TC-MO
Copy link
Contributor

@TC-MO TC-MO commented May 29, 2025

restructure the document
expand with technical part of integration playbok
add TODO for OAuth
formatting fixes
style guide fixes

TC-MO added 2 commits May 29, 2025 00:32
restructure the document
expand with technical part of integration playbok
add TODO for OAuth
formatting fixes
style guide fixes
@github-actions github-actions bot added the t-docs Issues owned by technical writing team. label May 29, 2025
@TC-MO TC-MO added the documentation Improvements or additions to documentation. label May 29, 2025
@apify-service-account
Copy link

Preview for this PR was built for commit 435034f0 and is ready at https://pr-1608.preview.docs.apify.com!

@TC-MO TC-MO linked an issue May 29, 2025 that may be closed by this pull request
4 tasks
remove Authentication sub headings and change them to paragraph
@apify-service-account
Copy link

Preview for this PR was built for commit c254f843 and is ready at https://pr-1608.preview.docs.apify.com!

@TC-MO TC-MO requested a review from MisaFialova May 29, 2025 13:13
@TC-MO TC-MO marked this pull request as ready for review May 29, 2025 13:13
@TC-MO TC-MO requested a review from davidjohnbarton May 29, 2025 13:19
@davidjohnbarton davidjohnbarton requested review from BraniganLee and removed request for davidjohnbarton May 29, 2025 15:57
@tomnosek
Copy link
Contributor

A couple of comments from me:

  • I'd format the intro to Integration types to bullet points, similarly to how Integrating with Apify has it already. I think italicizing general and Actor-specific isn't sufficient for comfortable reading.
  • I'd change the Integrating with Apify heading for something like Getting started or Building integrations because the current heading just repeats the article's name; therefore, it doesn't really distinguish what it'll be about.
  • There's one "the Apify Store" and "the Apify Console", where the shouldn't be there. But I believe Dan will catch these.

@TC-MO
Copy link
Contributor Author

TC-MO commented May 30, 2025

All valid points @tomnosek, just a bit of context for 1.

My train of thought was we introduce the concepts in paragraph with very brief explanations and then they have their own separate paragraphs & headings. I also didn't want to overuse bullet points, while generally they make it easier to read and scan, there already is quite a number of them throughout the whole text.

@apify-service-account
Copy link

Preview for this PR was built for commit b6c03974 and is ready at https://pr-1608.preview.docs.apify.com!

@apify-service-account
Copy link

Preview for this PR was built for commit 9b792c15 and is ready at https://pr-1608.preview.docs.apify.com!

@TC-MO TC-MO requested a review from BraniganLee June 11, 2025 12:09
Copy link

@MisaFialova MisaFialova left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Building an integration Actor

The best way to reach out to Apify users is directly within Apify Console.

I don't think this is necessarily the best way to reach out to Apify users and the external integration being the alternative, as we say in the next paraghraph. It makes sense we mention the integration Actor option here - but I wouldn't label it as a best way.

@TC-MO

Copy link

@MisaFialova MisaFialova left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@TC-MO The only thing I'm missing is mentioning our MCP here. I asked the AI team to provide some info that could be added, but they haven't added it yet, so we can do that in next iteration.

Otherwise you can see my comment's directly int the text and it's good to go from my side.

@apify-service-account
Copy link

Preview for this PR was built for commit 4eb1c773 and is ready at https://pr-1608.preview.docs.apify.com!

@apify-service-account
Copy link

Preview for this PR was built for commit 4ff90356 and is ready at https://pr-1608.preview.docs.apify.com!

@apify-service-account
Copy link

Preview for this PR was built for commit 7d8b6f10 and is ready at https://pr-1608.preview.docs.apify.com!

@TC-MO TC-MO merged commit 6849c4d into master Jun 12, 2025
9 checks passed
@TC-MO TC-MO deleted the integration-playbook branch June 12, 2025 07:46
@apify-service-account
Copy link

Preview for this PR was built for commit 8e33aa83 and is ready at https://pr-1608.preview.docs.apify.com!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation. t-docs Issues owned by technical writing team.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Integration playbook integration into docs
5 participants