Skip to content
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

Docs: Add/update resource handler topics for datasource and app plugins #1081

Merged
merged 7 commits into from
Sep 10, 2024

Conversation

marefr
Copy link
Member

@marefr marefr commented Aug 28, 2024

Closes #878
Closes #1032

@marefr marefr added type/docs Changes only affect the documentation no-changelog Don't include in changelog and version calculations labels Aug 28, 2024
@marefr marefr self-assigned this Aug 28, 2024
Copy link

github-actions bot commented Aug 28, 2024

Hello! 👋 This repository uses Auto for releasing packages using PR labels.

✨ This PR can be merged. It will not be considered when calculating future versions of the npm packages and will not appear in the changelogs.

@marefr marefr changed the title Docs: Add/update resource handler topics for datasource and plugins Docs: Add/update resource handler topics for datasource and app plugins Aug 28, 2024
Copy link
Contributor

@andresmgot andresmgot left a comment

Choose a reason for hiding this comment

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

Content LGTM!

Copy link
Member

@academo academo left a comment

Choose a reason for hiding this comment

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

You should attempt to make the content about CallResourceHandler generic (no mention of app or data source), put it in a shared file and import it in both guides. Then in data sources you can put the specific frontend code and in app the specific frontend app code.

@marefr
Copy link
Member Author

marefr commented Sep 9, 2024

You should attempt to make the content about CallResourceHandler generic (no mention of app or data source), put it in a shared file and import it in both guides. Then in data sources you can put the specific frontend code and in app the specific frontend app code.

@academo @andresmgot I think I've managed to do what you suggested. PTAL 🙏

@marefr marefr marked this pull request as ready for review September 9, 2024 19:20
@marefr marefr requested a review from a team as a code owner September 9, 2024 19:20
Copy link
Contributor

@andresmgot andresmgot left a comment

Choose a reason for hiding this comment

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

LGTM, I only have a couple minor suggestions

docusaurus/docs/shared/implement-resource-handler.md Outdated Show resolved Hide resolved
docusaurus/docs/shared/implement-resource-handler.md Outdated Show resolved Hide resolved

## Uses of resource handlers

The use case and functionality for an app is very broad and therefore also for uses of resource handlers. But in general, an app normally integrates with a HTTP service of some kind, e.g. a 3rd party service, to retrieve and send data. For example, this service might have
Copy link
Member

Choose a reason for hiding this comment

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

The use case and functionality for an app is very broad and therefore also for uses of resource handlers.

This sentence confused me a bit, could you rephrase it?

Copy link
Member Author

Choose a reason for hiding this comment

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

PTAL

@marefr marefr merged commit 5f8096f into main Sep 10, 2024
12 checks passed
@marefr marefr deleted the docs_878 branch September 10, 2024 13:27
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
no-changelog Don't include in changelog and version calculations type/docs Changes only affect the documentation
Projects
3 participants