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

[Docs] Mermaid diagrams not rendering #4864

Open
2 tasks done
davidmirror-ops opened this issue Feb 8, 2024 · 2 comments · May be fixed by #5373
Open
2 tasks done

[Docs] Mermaid diagrams not rendering #4864

davidmirror-ops opened this issue Feb 8, 2024 · 2 comments · May be fixed by #5373
Labels
backlogged For internal use. Reserved for contributor team workflow. bug Something isn't working documentation Improvements or additions to documentation

Comments

@davidmirror-ops
Copy link
Contributor

Description

Example: https://docs.flyte.org/en/latest/deployment/configuration/auth_appendix.html

The mermaid diagrams in this page (and probably others) are not rendering.

This is confirmed by multiple users and different browsers

Are you sure this issue hasn't been raised already?

  • Yes

Have you read the Code of Conduct?

  • Yes
@davidmirror-ops davidmirror-ops added documentation Improvements or additions to documentation untriaged This issues has not yet been looked at by the Maintainers labels Feb 8, 2024
Copy link

dosubot bot commented Feb 8, 2024

🤖

Hey there, @davidmirror-ops! Great to bump into you again in the digital corridors of GitHub. How's it going on your side of the screen?

Based on the provided context, it seems like the issue with the Mermaid diagrams not rendering on the Flyte documentation pages could be due to the configuration of the Sphinx Mermaid extension. Currently, the mermaid_output_format is set to "raw", which means the Mermaid diagrams are not being processed into a viewable format like SVG or PNG.

Here is the current configuration in the docs/conf.py file:

# Sphinx-mermaid config
mermaid_output_format = "raw"
mermaid_version = "latest"
mermaid_init_js = "mermaid.initialize({startOnLoad:false});"

To resolve this issue, you could change the mermaid_output_format to "svg" or "png". This will ensure that the Mermaid diagrams are processed into a format that can be rendered in the browser. Here's how you can do it:

mermaid_output_format = "svg"

Or:

mermaid_output_format = "png"

Please note that this change should be made by someone with write access to the repository. If you don't have the necessary permissions, you might want to bring this to the attention of someone who does.

I hope this helps! If you have any other questions or need further clarification, feel free to ask.

Sources


This response is meant to be useful and save you time. It is not meant to be a precise solution, but rather a starting point for your own research.

Help me be more useful! Please leave a 👍 if this is helpful and 👎 if it is irrelevant.

If you want to continue the conversation, start your reply with @dosu-bot.

@dosubot dosubot bot added the bug Something isn't working label Feb 8, 2024
@eapolinario eapolinario added backlogged For internal use. Reserved for contributor team workflow. and removed untriaged This issues has not yet been looked at by the Maintainers labels Feb 8, 2024
@davidmirror-ops
Copy link
Contributor Author

The diagram referenced in this section is also not rendering: https://docs.flyte.org/en/latest/deployment/configuration/general.html#evaluation-order-in-podtemplates

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
backlogged For internal use. Reserved for contributor team workflow. bug Something isn't working documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants