search

openedx / docs.openedx.org

[BETA] A new home for learning about Open edX
https://docs.openedx.org
Other
7 stars 57 forks source link

Issue with page: source/translators/concepts/translation-process.rst (remove Mermaid) #591

Open sarina opened 3 weeks ago

sarina commented 3 weeks ago

Filename

source/translators/concepts/translation-process.rst

What persona(s) does this page touch? (skip if you don't know)

No response

What is broken about this file?

Other (detail below)

Provide any extra details, such as LMS version, specifics of what's broken, or suggested remediation steps.

This file is the only one that uses the Mermaid package, which the maintainer has now stated they can no longer maintain. This page should be updated to use a different way of generating the image, or use a diagram maintained elsewhere (such as LucidChart).

A good option may be graphviz, which we use in the OEP repo. See https://github.com/openedx/open-edx-proposals/blob/master/oeps/processes/oep-0001.rst

sarina commented 3 weeks ago

Heads up @OmarIthawi if you're thinking about making new Translators docs, to not follow the pattern of using mermaid