[Migration Research] Find and evaluate solutions for migrating HTML docs

[caylahamann]

Summary

In the current docs site, there are

• 1599 Basic pages (HTML, unstructured)
• 144 API docs (HTML, semi-structured)
• 143 Trouble shooting docs (HTML, semi-structured)

We need to figure out a method to migrate this content into this repository into mdx files. @austin-schaefer will be determining a representative sample of documents for us to migrate over for our POC.

Procedure

Open up a PR merging into research. If there is no changes in the code (and only research details), you can just make an edit in a text file, since there is no plan to merge this into main. Use the PR template research_PR_template.md either by coping the markdown into the PR or by appending the query string ?template=research_PR_template.md to the URL. Fill out the template by answering the research questions listed below.

Research Goals

• Investigate methods of HTML to mdx file migration
• Determine/estimate the amount of work for the implementation of each method
• Determine the amount of manual work (i.e. are there any pages that we can't transfer over programmatically? why?)
• Create POC for one of the methods of HTML to mdx file migration for the representative sample of documents

[roadlittledawn]

some extra context: we can output each piece of content (node in Drupal speak), along with most of its relevant fields, via JSON to help with migration. one caveat there is release notes: some are authored in HTML, some (maybe most?) are authored in markdown. i believe we can output either markdown or HTML, but it would have to be separate endpoints.

[zstix]

We've decided to break this generalized ticket into 4 smaller, more targeted, tickets (referenced above). I'm marking this one as closed.