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

Properly render ACL in documentation #1994

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

lkiesow
Copy link
Contributor

@lkiesow lkiesow commented Jun 25, 2024

The ACL example in the documentation specifies the highlighting as JSON, but it has comments which causes GitHub to render them as errors. Comments are allowed in the JSON5 extension, however, to which this patch switches.

Here is how this looks before and after the change:

Screenshot from 2024-06-25 09-57-51

  • have read the CONTRIBUTING.md file
  • raised a GitHub issue or discussed it on the projects chat beforehand
  • added unit tests
  • added integration tests
  • updated documentation if needed
  • updated CHANGELOG.md

The ACL example in the documentation specifies the highlighting as JSON, but it has comments which causes GitHub to render them as errors. Comments are allowed in the JSON5 extension, however, to which this patch switches.
@nblock
Copy link
Contributor

nblock commented Sep 8, 2024

Unfortunately, this breaks the rendering in mkdocs:

With json5 (broken)
image

With json (ok)
image

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