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

refactor: connector fragments used in generating tutorials #952

Merged

Conversation

charIeszhao
Copy link
Member

@charIeszhao charIeszhao commented Jan 2, 2025

Summary

Refactor onnector fragments for generating "Build X with Y" tutorials

  1. Create a new docusaurus plugin to generate tutorials, as it would be needed when generating i18n locales.
  2. Update connector guides in docs/integrations folder. Extract fragment for both connector guide and tutorial.
  3. Update the SDK fragment used for generating tutorials.
  4. Place the above connector fragments and SDK fragments in docs folder (previously in tutorial folder), so that they can be picked up by the translation script.
  5. Move tutorial generation used metadata in SDk and connector guides separately. (Previously in the generate.mjs script)
  6. Sync doc translations.
  7. Add heading IDs in the above fragments, so they can be kept in generated tutorials upon translation.

Testing

  • Build was successful on local machine.
  • English version tutorial contents were updated, based on latest SDK and connector guides.
  • Locally tested with i18n tutorial translation. More locales will be committed in the follow-up PRs.

@charIeszhao charIeszhao requested a review from a team January 2, 2025 12:07
@charIeszhao charIeszhao self-assigned this Jan 2, 2025
Copy link

cloudflare-workers-and-pages bot commented Jan 2, 2025

Deploying logto-docs with  Cloudflare Pages  Cloudflare Pages

Latest commit: dd37b34
Status: ✅  Deploy successful!
Preview URL: https://3d8c373d.logto-docs.pages.dev
Branch Preview URL: https://charles-log-10672-refactor-t.logto-docs.pages.dev

View logs

@charIeszhao charIeszhao merged commit 86b4c63 into master Jan 6, 2025
7 of 9 checks passed
@charIeszhao charIeszhao deleted the charles-log-10672-refactor-tutorial-generation-templates branch January 6, 2025 04:24
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Development

Successfully merging this pull request may close these issues.

2 participants