Skip to content

Migrate Gatsby version on clayui.com from 1.x to 2.x #1205

Closed
@matuzalemsteles

Description

We need to migrate from Gatsby 1.x to 2.x, so we can start working on automating our documentation using Clay components.

Disclaimer

Currently we use gatsby-remark-component to use React components in .md files, but are interpreted as a WebComponents and makes it difficult to maintain, we have to configure each component.

We can use gatsby-mdx, to use React components as md files, the files are interpreted as a jsx, but we still continue to maintain them as md files.

Just a few caveats if we start automating our documentation, with Gatsby version 2, it has become much more performative for editing and build time, but by going with automation, we're creating more steps that are putting down performance.

  • This makes bad maintenance, fast loading time increases, and the experience to test things.

Environment Nightly

We have to start creating a Nightly environment (it's just a key to telling Gatsby not to do certain things and optimize...) as discussed in #1111 to improve the testing experience for Patrick.

  • Deactivate the gatsby-mdx plugin for Nightly files. And they will load faster when being edited.

The idea is for this to work just fine when Patrick wants to test his markups and CSS changes and in the future we can further optimize that environment.

Metadata

Labels

comp: clayui.comIssues related to website infrastructure or other things outside the documentationstatus: next-releaseIssues that will enter into the next releasetype: enhancementIssues that are open to bring improvements or refinement of code

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions