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

🐛 📚 Fix mermaid diagram generation on Ubuntu #115

Merged
merged 1 commit into from
Oct 29, 2024

Conversation

elbeno
Copy link
Contributor

@elbeno elbeno commented Oct 28, 2024

Problem:

Solution:

Problem:
- Ubuntu 23.10 and later has security rules around running chrome, which means
  mermaid-cli can't generate diagrams without a workaround.
- See mermaid-js/mermaid-cli#730

Solution:
- Provide a puppeteer_config.json file in the docs directory which can be passed
  to mmdc by specifying an attribute in AsciiDoctor markdown.
- See https://docs.asciidoctor.org/diagram-extension/latest/diagram_types/mermaid/
@bdeane-intel
Copy link
Contributor

Notice the current published documentation has broken image generation: https://intel.github.io/cicd-repo-infrastructure/#_documentation_workflow

@elbeno elbeno enabled auto-merge October 29, 2024 16:00
@elbeno elbeno merged commit 9475512 into intel:dev Oct 29, 2024
5 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants