react-magma icon indicating copy to clipboard operation
react-magma copied to clipboard

SPIKE: Figure out next steps on doc site build

Open jwad03 opened this issue 1 year ago • 0 comments

We need to figure out what to do about our docs site. We are currently using Gatsby v3, which is no longer supported and 2 versions behind.

Some considerations:

  • How do we keep our dependencies up to date and avoid staying so far behind?
  • ~~How do we make our docs site compatible with our upcoming Carbon Charts work?~~
  • What is the level of effort for each of the options below, and which makes the most sense considering our future work?

Options:

  • Upgrade to v4
  • Upgrade to v5
  • Move away from Gatsby and replace with NextJS

(from conversation with Ryan) What are the pain points / why should we consider moving away from Gatsby?

Pain points:

  • Does not play well with storybook
  • Has underlying dependencies that have not been updated in a while
  • GraphQL is sitting on Gatsby, so this may be the biggest challenge about moving away from it

Suggestions:

  • NextJS would be a great alternative to consider
  • Timebox investigating the upgrade

jwad03 avatar Apr 03 '24 19:04 jwad03