osf.io icon indicating copy to clipboard operation
osf.io copied to clipboard

[Django Upgrade] [ENG-3947] Update markdown extension

Open Johnetordoff opened this issue 2 years ago • 2 comments

Purpose

Old versions of markdowns python library no longer work with Django so we have to upgrade Markdown to be compatible and update a few functions.Additionally Our forked markdown extension library https://github.com/CenterForOpenScience/mdx_del_ins/ is no longer compatible with markdown, so it had to have a minor fork. https://github.com/CenterForOpenScience/mdx_del_ins/pull/1

https://www.notion.so/cos/6188c43512ee482586da59bc5fdacf38?v=bb051c7d4d7346d69d9fcbbc979dd883&p=02a1b6368b0b47fbbab07a01d88135d9&pm=s

Error: https://gist.github.com/Johnetordoff/84c900be9f2427db40ac57d18386cf6f

Changes

  • updates markdown to use new format for passing arguments
  • forks mdx_del_ins to work with new version of markdown.

QA Notes

Please make verification statements inspired by your code and what your code touches.

  • Verify
  • Verify

What are the areas of risk?

Any concerns/considerations/questions that development raised?

Documentation

Side Effects

Ticket

Johnetordoff avatar Jul 20 '22 14:07 Johnetordoff

@cslzchen After replicating this issue, it seems that the markdown problem was caused by a DRF incompatibility Error I'm looking to see if there's a version of DRF that works with both Django 3.2 and our current markdown, but it doesn't look like there's a version that satisfies both, so changing Markdown seems easiest.

Johnetordoff avatar Aug 10 '22 19:08 Johnetordoff

@cslzchen After replicating this issue, it seems that the markdown problem was caused by a DRF incompatibility Error I'm looking to see if there's a version of DRF that works with both Django 3.2 and our current markdown, but it doesn't look like there's a version that satisfies both, so changing Markdown seems easiest.

Ah, I see. I remember this AttributeError: 'OrderedDict' object has no attribute 'register' error on one of my reference PRs too. Let me take another look at this one.

cslzchen avatar Aug 10 '22 19:08 cslzchen