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

πŸ“ Framework Guides + Gatsby Migration Guide – v2 – Visual Editing Enabled #2417

Open
2 tasks
isaaclombardssw opened this issue Nov 5, 2024 · 1 comment

Comments

@isaaclombardssw
Copy link
Contributor

isaaclombardssw commented Nov 5, 2024

πŸ’« Describe the Issue With the Current Docs

There's a new guide on Gatsby + Tina migrations which goes over setup of Tina in a Gatsby project.

There's also an existing framework guide – https://tina.io/docs/frameworks/gatsby.

These Framework guides should be moved to the Guides menu item.
The migration + set-up guides should be merged or live in the same location.

Additionally, Visual Editing is possible with Gatsby and the guide doesn't go over that and the actual caveats.

πŸ“ Outline the Proposed Change

  1. Move framework guides in the Guides ToC item
  2. Update the content of https://tina.io/docs/guides/converting-gatsby-to-tina based on this Repo Creating Gatsby x Tina starterΒ tina-gatsby-starter#1.
  3. Rename menu items so 'Framework Guides | Gatsby |' new project guide and migration guide

πŸ’Ό Tasks

  • Make above changes or find a suitable alternative to consolidate information
  • Do other frameworks warrant a "migration guide"? Discuss with the CMS and .io team – if so create PBIs for each target framework
@Calinator444
Copy link
Contributor

Looks good! I've started migrating the blog sample for the tutorial for Typesript/ESM

The approach the French team came up with for enabling live editing involves importing the tina client into gatsby-node but it can't be imported by default because it's an ES Module and Gatsby uses Common JS by default.

https://github.com/tinacms/gatsby-mdx-example-blog/tree/migrate-to-typescript

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants