Add Flotiq and Astro integration guide #9798
Conversation
✅ Deploy Preview for astro-docs-2 ready!Built without sensitive environment variables
To edit notification comments on pull requests, go to your Netlify site configuration. |
Lunaria Status Overview🌕 This pull request will trigger status changes. Learn moreBy default, every PR changing files present in the Lunaria configuration's You can change this by adding one of the keywords present in the Tracked Files
Warnings reference
|
sarah11918
added
3rd-party guide
|
Hi @trzcina ! Thank you for submitting this guide! We hope to be able to start reviewing it this week! 🚀 |
There was a problem hiding this comment.
Thanks for the PR @trzcina! I've run through the recipe once, and made some initial notes about the order of steps, and using other package managers. Once we figure those out, I'll go through and review the copy.
The only issue I ran into was regenerating the SDK. I used pnpm, but running pnpm add flotiq-api-ts, even with --force, didn't regenerate the SDK after changing my content type. Deleting node_modules and installing with npm worked fine. Is it possible to regenerate the SDK with pnpm at all?
| ### Setting up the Environment variables | ||
|
|
||
| Add the read-only API key from your Flotiq account to the `.env` file in the root of your Astro project: | ||
|
|
||
| ```ini title=".env" | ||
| FLOTIQ_API_KEY=__YOUR_FLOTIQ_API_KEY__ | ||
| ``` |
There was a problem hiding this comment.
nit: This might be better above the previous step, as we tell the user how to get the environment variable in the prerequisites. Then they can immediately paste and forget.
There was a problem hiding this comment.
Right, I’ve moved the section closer to the prerequisites section.
|
Thanks @TheOtterlord! I’ll prepare an improved version incl. a component featuring tabs. The most important thing for me is to check why the SDK didn’t update after |
Co-authored-by: Reuben Tier <[email protected]>
* Add PackageManagerTabs * Add npm and pnpm examples
Add package manager tabs to the Refreshing SDK section
|
Hey @trzcina ! Thanks for working with @TheOtterlord and for your patience! It looks like all the procedure was figured out, and I'll be looking at this in the next couple of days for a style/language pass. We should have this merged by the end of the week, if all goes well! 🙌 |
There was a problem hiding this comment.
Sorry, you didn't give permission for maintainers to edit, so I had to make one big suggestion on the whole file! 😅
These are some light text/language edits throughout, so I'd suggest the easiest thing to do here is accept the suggestion and then review to make sure nothing is wrong!
Co-authored-by: Sarah Rainsberger <[email protected]>
|
Thanks, @sarah11918! I reviewed and committed your suggested changes. Thanks for the suggestions — looks good now. |
|
Hi @trzcina ! Thank you for making that commit, but you also have to give maintainers permission to edit so we can do basic things like update the branch. Please edit the permissions on this PR for us so we can continue with it! 🙌 Then it won't be too long until we can merge it! 🥳 |
| </Fragment> | ||
| <Fragment slot="yarn"> | ||
| ```sh | ||
| yarn add flotiq-api-ts |
There was a problem hiding this comment.
shouldn't this be rebuild? or am i missing something
| yarn add flotiq-api-ts | |
| yarn rebuild flotiq-api-ts |
This documentation provides a step-by-step guide for integrating the Flotiq headless CMS with Astro. It helps developers enhance their Astro projects by incorporating dynamic content from Flotiq.
The guide covers the following topics: