Skip to content

Auditing during/after docusaurus and content upgrade

Description

Our entry point for our community in Eclipse Tractus-X is our static web page (gh pages and docusaurus). The page itself is based on docusaurus. With the beginning of Monday (24.3.) we plan a maintenance phase (expected for round about 2 weeks) where we would like to upgrade to the newest docusaurus version 3.7.X

Unfortunately, the upgrade comes with a new MDX checker and new requirements towards the Markdown syntax. This is the reason we have to adapt a lot of content.

We cannot work on the main branch because the page needs to be online for our community.

My Plan:

  • We will work on a fork, created by myself
  • The content can be devised into 21 topics, so I would like to work on 21 different branches
  • Each branch should be merged to main on the fork
    • Supported and already approved by a committer
    • for each PR I would like to create an IP issue (i expect more than 1000 changes per PR)
  • After the work is done, the fork main should be merged to origin main (big bang)

By splitting up the changes into smaller peaces, I would expect we wouldn't need an IP issue for the (big bang) and also the approval by a committer (where TBH the review would be never ever possible) should be OK by “just” clicking approve.

=> Is my assumption here correct? Just want to be on the save side. Thanks,


I already had a nice call with @rahulmohang, and he suggested creating this issue and also tagging @wbeaton