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

Settings fix for mdx3 errors #3088

Closed
gingerwizard opened this issue Jan 15, 2025 · 0 comments · Fixed by #3112
Closed

Settings fix for mdx3 errors #3088

gingerwizard opened this issue Jan 15, 2025 · 0 comments · Fixed by #3112
Assignees
Labels

Comments

@gingerwizard
Copy link
Contributor

Currently settings generation causes mdx3 violations which blocked docusaurus v3 update. To work around this we fix manually in generation script.

# Replace issue sequences for mdx3
if [[ "$OSTYPE" == "darwin"* ]]; then
# macOS
# allow_archive_path_syntax
sed -i '' 's#'\''\\\\<archive\\\\> :: \\\\<file\\\\>'\''#\`<archive> :: <file>\`#g' docs/en/operations/settings/settings.md
# max_partitions_to_read
sed -i '' "s/<= 0 means unlimited/\&lt;0 means unlimited/g" docs/en/operations/settings/settings.md
# optimize_time_filter_with_preimage
sed -i '' "s|toYear(col) = 2023 -> col >= '2023-01-01' AND col <= '2023-12-31'|\\\`toYear(col) = 2023 -> col >= '2023-01-01' AND col <= '2023-12-31'\\\`|g" docs/en/operations/settings/settings.md
# stop_refreshable_materialized_views_on_startup
sed -i '' 's@\\\\<name\\\\>@\\<name>@g' docs/en/operations/settings/settings.md
else
# Linux
# allow_archive_path_syntax
sed -i 's#'\''\\\\<archive\\\\> :: \\\\<file\\\\>'\''#\`<archive> :: <file>\`#g' docs/en/operations/settings/settings.md
# max_partitions_to_read
sed -i "s/<= 0 means unlimited/\&lt;0 means unlimited/g" docs/en/operations/settings/settings.md
# optimize_time_filter_with_preimage
sed -i "s|toYear(col) = 2023 -> col >= '2023-01-01' AND col <= '2023-12-31'|\\\`toYear(col) = 2023 -> col >= '2023-01-01' AND col <= '2023-12-31'\\\`|g" docs/en/operations/settings/settings.md
# stop_refreshable_materialized_views_on_startup
sed -i 's@\\\\<name\\\\>@\\<name>@g' docs/en/operations/settings/settings.md
fi

Ideally this wouldn't be needed. cc @alexey-milovidov we can fix these settings if you're ok enforcing these escape rules on the team.

cc @Blargian

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants