SSWConsulting / SSW.Rules

Generator for ssw.com.au/rules
https://www.ssw.com.au/rules
MIT License
15 stars 13 forks source link

📝 Docs - Document Gatsby + Tina #1586

Open bradystroud opened 2 weeks ago

bradystroud commented 2 weeks ago

There are already some old, half-baked Gatsby docs and we are writing some new ones.

Acceptance Criteria

Have a plan of what the docs should look like. e.g. what items will be in the ToC and where

isaaclombardssw commented 1 day ago

Pre-existing Gatsby Content on Tina.io

  1. A number of blog posts (all 2+ years old, not longer relevant) --> should we write a new one on getting Gatsby working (assuming Hugo + Gilles starter goes smoothly) + the process behind creating it? Note: these's are also only accessible by direct link and have been marked as depreciated, so no change needed on our part as this is ideal status for em.

ex. https://tina.io/blog/creating-markdown-drafts

⏸ No action needed.

  1. Updated docs | frameworks | Gatsby – for correctness. Still need to link to the gatsby conversion guide (“for a more detailed tutorial, see …”). https://tina.io/docs/frameworks/gatsby Updating this is currently in the works - see Hugo’s PR https://github.com/tinacms/tina.io/pull/2412.

🚧 WIP.

  1. The Gatsby examples under the Image Field has some Gatsby image formatting – I believe it’s not totally up to date, using ‘fluid’ images which have been depreciated. We should also move this kind of info elsewhere.

ex. https://tina.io/docs/reference/toolkit/fields/image#proper-image-paths-in-gatsby

✅ Done.

  1. Caleb’s guide – converting Gatsby to Tina.io… this will need to be updated to the better way (see Hugo and Gilles starter) as it is possible to get visual editing working. There’s some caveat Hugo mentioned about the header being too permissive. Do we need to add a warning callout for this? Also these two guides should be co-located in the ToC somehow.

🛑 Awaiting consensus on the starter – are we promoting that approach?

What to add

  1. Blog posts – we should we write a new one on getting Gatsby up and running (assuming Hugo + Gilles starter goes smoothly) with Tina again, many systems still live on Gatsby, etc. etc. – and how we we’re committed to improving Tina with xyz.

It would be a good place to bring attention to the new docs pages and starter.

🤔 TBC – is this a good idea?

  1. As per a conversation with Landon, frameworks each have their own page such as https://tina.io/hugo-cms and https://tina.io/nextjs-cms – they mostly exist for google juice (they need to be audited and reworked visually).

Gatsby should have a similar page.

🛑 Awaiting consensus on the starter – are we promoting that approach? 🔺 Vercel preview – https://tina-dkedqx55z-tinacms.vercel.app/gatsby-cms/

  1. As per a conversation with Landon, framework page to help people choose a framework – at least a blog post but Landon and I think a resource page (and we can link to all the weird offshoot pages in (2)).

🆕 PBI exists, to be completed.