Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Open
sarina opened this issue Oct 17, 2024 · 1 comment
Labels
good first issue A good task for a newcomer to start with

Comments

@sarina
Copy link
Contributor

sarina commented Oct 17, 2024

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 sarina added the good first issue A good task for a newcomer to start with label Oct 17, 2024
@sarina
Copy link
Contributor Author

sarina commented Oct 17, 2024

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
good first issue A good task for a newcomer to start with
Projects
None yet
Development

No branches or pull requests

1 participant