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 #1618

Open
Calinator444 opened this issue Nov 5, 2024 · 3 comments
Assignees

Comments

@Calinator444
Copy link
Member

Copy of PBI (tinacms/tina.io#2417)

πŸ’« 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
Move framework guides in the Guides ToC item
Update the content of https://tina.io/docs/guides/converting-gatsby-to-tina based on this Repo tinacms/tina-gatsby-starter#1.
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
Member Author

Created this to document the work that I did on the guide.

I've left a comment on the original PBI explaining where I got up to, but we're currently unsure if the guide should exist separately or as part of the Tina setup guide.

tinacms/tina.io#2417 (comment)

@JackDevAU
Copy link
Member

As per our conversation, (+ @bradystroud ) please continue with updating this to TS. (Should use TS as the default). Then add the Visual Editing as a new page that sits right after the current migration guide.

@Calinator444
Copy link
Member Author

The guide has an approving review and is currently in staging, but needs a review from a code owner.

https://tina-6ftsw7jqm-tinacms.vercel.app/docs/guides/converting-gatsby-to-tina

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