Document how to extend integration hooks by Fryuni · Pull Request #8701 · withastro/docs

Fryuni · 2024-06-28T05:48:53Z

Description

Document new feature allowing integrations to expose hooks for other integrations.
Implementation PR: feat: Refactor integration hooks type astro#11304

astrobot-houston · 2024-06-28T05:51:40Z

Lunaria Status Overview

🌕 This pull request will trigger status changes.

Learn more

By default, every PR changing files present in the Lunaria configuration's files property will be considered and trigger status changes accordingly.

You can change this by adding one of the keywords present in the ignoreKeywords property in your Lunaria configuration file in the PR's title (ignoring all files) or by including a tracker directive in the merged commit's description.

Tracked Files

Locale	File	Note
en	reference/integrations-reference.mdx	Source changed, localizations will be marked as outdated.

Warnings reference

Icon	Description
🔄️	The source for this localization has been updated since the creation of this pull request, make sure all changes in the source have been applied.

delucis

Thanks Luiz! Left some notes.

src/content/docs/en/reference/integrations-reference.mdx

delucis · 2024-07-01T22:14:25Z

src/content/docs/en/reference/integrations-reference.mdx

+
+```ts
+// your-integration/index.ts
+import './types.ts';


Realised we kind of skim over this import. Maybe should be mentioned in the introduction that this is needed?

It's a bit complicated. It is not required at all; you just have to have some way for the consumer integration to load the type augmentation from the provider integration, and this makes it the most intuitive (by just importing the integration).

But there are multiple ways of doing it and IMHO none of them are intuitive for non-TS-power-users

This is in the integration code itself though. If it’s not needed, maybe we remove it?

Maybe I wasn't clear. Loading the type augmentation is required, but it isn't required to be done this way.

I'll explain this in the text

sarah11918 · 2024-07-02T12:01:17Z

Hey @Fryuni , thanks for this addition! In general, I agree with all of Chris's edits here, but I'd like your confirmation before committing them to have as a base for me to start editing.

Can you take a look over Chris's comments here and resolve them all before I do my (more text-based/structural) reviewing and possibly editing for language? Thanks! 🙌

[skip ci] Co-authored-by: Chris Swithinbank <swithinbank@gmail.com>

sarah11918

Hey @Fryuni , so excited to have this feature in docs!

I've left some comments/questions, some of which are absolutely coming from a lack of familiarity with authoring integrations, so I apologize for the hand-holding I'll need.

The main takeaways here are: I'd prefer a concrete example showing an actual use case, and I'm thinking that the page hierarchy might best change here.

I think there's a case to be made for this entire section being an <h2> and the whole thing is not about "defining custom hooks" but rather "creating and using custom hooks" (As I've mentioned in one comment, maybe that means that the existing "Hooks" would be improved as "Provided Hooks" or something like that)

Anyway, process this and see what of my comments make any sense! 😄

src/content/docs/en/reference/integrations-reference.mdx

sarah11918

I think this is looking pretty good?? In fact, when reviewing your PR initially, it kind of bothered me that we didn't say anything for Hooks, so this seems like a real improvement across the board!

Are you happy if this PR becomes just this reference documentation, or would you like to also try to fit in a recipe/guide in the same way we did for the Dev Toolbar API page?

src/content/docs/en/reference/integrations-reference.mdx

Co-authored-by: Sarah Rainsberger <sarah@rainsberger.ca>

Fryuni · 2024-07-08T18:10:08Z

Are you happy if this PR becomes just this reference documentation, or would you like to also try to fit in a recipe/guide in the same way we did for the Dev Toolbar API page?

I think the recipe/guide should go on a separate PR. It is not a requirement to get the feature released.

src/content/docs/en/reference/integrations-reference.mdx

netlify · 2024-07-12T11:07:27Z

✅ Deploy Preview for astro-docs-2 ready!

Name	Link
🔨 Latest commit	`8ea9d47`
🔍 Latest deploy log	https://app.netlify.com/sites/astro-docs-2/deploys/669258a282a4500008c18f46
😎 Deploy Preview	https://deploy-preview-8701--astro-docs-2.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

sarah11918

Approving for 4.12 release!

Co-authored-by: Sarah Rainsberger <sarah@rainsberger.ca>

sarah11918 · 2024-07-14T12:05:27Z

!coauthor

github-actions · 2024-07-14T12:05:40Z

Co-authored-by: Houston (Bot) <108291165+astrobot-houston@users.noreply.github.com>
Co-authored-by: Sarah Rainsberger <sarah@rainsberger.ca>
Co-authored-by: Chris Swithinbank <357379+delucis@users.noreply.github.com>

Document how to extend integration hooks

3c83116

Fryuni self-assigned this Jun 28, 2024

This comment was marked as outdated.

Sign in to view

Fryuni added the minor-release For the next minor release; in the milestone, "merge queue" when approved by Sarah! label Jun 28, 2024

vercel bot deployed to Preview – docs June 28, 2024 05:52 View deployment

Fryuni requested a review from sarah11918 June 28, 2024 06:01

sarah11918 added add new content Document something that is not in docs. May require testing, confirmation, or affect other pages. merge-on-release Don't merge this before the feature is released! (MQ=approved but WAIT for feature release!) labels Jun 28, 2024

delucis reviewed Jul 1, 2024

View reviewed changes

sarah11918 added this to the 4.12.0 milestone Jul 2, 2024

Apply suggestions from code review

aa8b230

[skip ci] Co-authored-by: Chris Swithinbank <swithinbank@gmail.com>

vercel bot deployed to Preview – docs July 2, 2024 17:54 View deployment

Update src/content/docs/en/reference/integrations-reference.mdx

4a73d52

[skip ci] Co-authored-by: Chris Swithinbank <swithinbank@gmail.com>

vercel bot deployed to Preview – docs July 2, 2024 23:14 View deployment

Fryuni added 2 commits July 2, 2024 21:09

Improve (hopefully) the explanation

7cab010

Merge branch 'main' into fryuni/extendable-integration-hooks

5ca93ad

vercel bot deployed to Preview – docs July 3, 2024 00:15 View deployment

sarah11918 reviewed Jul 4, 2024

View reviewed changes

Less guidy and more referency

551d362

vercel bot deployed to Preview – docs July 8, 2024 11:46 View deployment

sarah11918 reviewed Jul 8, 2024

View reviewed changes

src/content/docs/en/reference/integrations-reference.mdx Outdated Show resolved Hide resolved

src/content/docs/en/reference/integrations-reference.mdx Outdated Show resolved Hide resolved

Apply suggestions from code review

3e4f040

Co-authored-by: Sarah Rainsberger <sarah@rainsberger.ca>

vercel bot deployed to Preview – docs July 8, 2024 18:11 View deployment

sarah11918 reviewed Jul 9, 2024

View reviewed changes

src/content/docs/en/reference/integrations-reference.mdx Outdated Show resolved Hide resolved

sarah11918 reviewed Jul 9, 2024

View reviewed changes

src/content/docs/en/reference/integrations-reference.mdx Outdated Show resolved Hide resolved

tiny edit

9a35fca

sarah11918 added the Merge Queue Approved and ready to be merged (wait for feature release if also labelled M-O-R)! label Jul 12, 2024

sarah11918 approved these changes Jul 12, 2024

View reviewed changes

vercel bot deployed to Preview – docs July 12, 2024 11:12 View deployment

Update src/content/docs/en/reference/integrations-reference.mdx

6dc6fa6

Co-authored-by: Sarah Rainsberger <sarah@rainsberger.ca>

vercel bot deployed to Preview – docs July 13, 2024 00:12 View deployment

Merge branch 'main' into fryuni/extendable-integration-hooks

8ea9d47

sarah11918 changed the base branch from main to 4.12.0 July 14, 2024 12:04

sarah11918 mentioned this pull request Jul 14, 2024

4.12.0 Minor release docs #8796

Merged

Merge branch '4.12.0' into fryuni/extendable-integration-hooks

b68d1dc

sarah11918 merged commit 61f684f into 4.12.0 Jul 14, 2024

sarah11918 deleted the fryuni/extendable-integration-hooks branch July 14, 2024 12:10

Nin3lee mentioned this pull request Jul 23, 2024

i18n(zh-cn): Update integrations-reference.mdx #8900

Merged

Uh oh!

Comments

Conversation

Fryuni commented Jun 28, 2024

Description

Uh oh!

This comment was marked as outdated.

astrobot-houston commented Jun 28, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Lunaria Status Overview

Tracked Files

Uh oh!

delucis left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

delucis Jul 1, 2024

Choose a reason for hiding this comment

Uh oh!

Fryuni Jul 2, 2024

Choose a reason for hiding this comment

Uh oh!

delucis Jul 2, 2024

Choose a reason for hiding this comment

Uh oh!

Fryuni Jul 2, 2024

Choose a reason for hiding this comment

Uh oh!

sarah11918 commented Jul 2, 2024

Uh oh!

sarah11918 left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

sarah11918 left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Fryuni commented Jul 8, 2024

Uh oh!

Uh oh!

Uh oh!

netlify bot commented Jul 12, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

✅ Deploy Preview for astro-docs-2 ready!

Uh oh!

sarah11918 left a comment

Choose a reason for hiding this comment

Uh oh!

sarah11918 commented Jul 14, 2024

Uh oh!

github-actions bot commented Jul 14, 2024

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

astrobot-houston commented Jun 28, 2024 •

edited

Loading

netlify bot commented Jul 12, 2024 •

edited

Loading