-
Notifications
You must be signed in to change notification settings - Fork 465
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
doc/user: convert all user docs to use mzsql highlighting where appropriate #27805
Merged
arusahni
merged 17 commits into
MaterializeInc:main
from
arusahni:docs/mzsql-highlighting
Jun 24, 2024
Merged
doc/user: convert all user docs to use mzsql highlighting where appropriate #27805
arusahni
merged 17 commits into
MaterializeInc:main
from
arusahni:docs/mzsql-highlighting
Jun 24, 2024
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Also fix a bug where PostgreSQL shortcodes were being used.
…sql highlighting where appropriate
…ing where appropriate
morsapaes
approved these changes
Jun 24, 2024
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thank you so much for this, @arusahni! ❤️ Also for correctly highlighting the PostgreSQL- and MySQL-specific bits.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Motivation
Syntax highlighting in our docs uses a general SQL highlighter. This is fine, but we don't have highlighting on Mz-specific keywords, which is suboptimal. I have upstreamed Materialize SQL dialect highlighting to Chroma, the highlighting library used by Hugo. We upgraded to a compatible version of Hugo in #27679 , so now we just need to apply the new syntax highlighting to all examples of Materialize SQL dialect in the docs. I took care to not update SQL Server, MySQL, and Postgres examples.
Before
After
If we're happy with this, and once it's merged, I'll work on formalizing the Chroma dialect update motion as a script so we can upstream new keywords as they land.
Tips for reviewer
Sorry for the large diff! I grouped sections of the docs by commit, so that may ease review. Please let me know if you'd prefer I submit this another way.
Checklist
$T ⇔ Proto$T
mapping (possibly in a backwards-incompatible way), then it is tagged with aT-proto
label.