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

Maintenance: Update the mkdocs configuration to support pymdown-extensions 10.0 #275

Closed
1 task done
hjgraca opened this issue May 16, 2023 · 0 comments · Fixed by #276 or #274
Closed
1 task done

Maintenance: Update the mkdocs configuration to support pymdown-extensions 10.0 #275

hjgraca opened this issue May 16, 2023 · 0 comments · Fixed by #276 or #274
Labels
internal Maintenance changes triage Pending triage from maintainers

Comments

@hjgraca
Copy link
Contributor

hjgraca commented May 16, 2023

Summary

Due to a CVE we need to add an extra configuration in mkdocs.yml to support the pymdown-extensions version 10.0.

Why is this needed?

If we update the version without changing the configuration, we get this error

poetry run mkdocs serve           
INFO     -  Building documentation...
INFO     -  Cleaning site directory
WARNING  -  A relative path to 'api/" target="_blank' is included in the 'nav' configuration, which is not found in the documentation files
ERROR    -  Error reading page 'core/logger.md': Snippet at path 'examples/logger/sam/template.yaml' could not be found

Which area does this relate to?

Automation

Solution

poetry install [email protected]
poetry run mkdocs serve

Acknowledgment

@hjgraca hjgraca added internal Maintenance changes triage Pending triage from maintainers labels May 16, 2023
@github-actions github-actions bot added the pending-release Fix or implementation already in dev waiting to be released label May 18, 2023
@hjgraca hjgraca removed the pending-release Fix or implementation already in dev waiting to be released label Jul 9, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
internal Maintenance changes triage Pending triage from maintainers
Projects
None yet
1 participant