Skip to content

Add Monaco Editor Migration Guide #9654

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.

Sign up for GitHub

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

Jump to bottom
Open
wants to merge 3 commits into
base: main
Choose a base branch
from
Open

Add Monaco Editor Migration Guide #9654

wants to merge 3 commits into from
+370 −0

Conversation

ananzh
Copy link
Member

@ananzh ananzh commented Apr 3, 2025 •
edited
Loading

Description

Add Monaco Editor Migration Guide

Partial Issues Resolved

#9642

Changelog

  • doc: Add Monaco Editor Migration Guide

Check List

  • All tests pass
    • yarn test:jest
    • yarn test:jest_integration
  • New functionality includes testing.
  • New functionality has been documented.
  • Update CHANGELOG.md
  • Commits are signed per the DCO using --signoff

@ananzh
Add Monaco Editor Migration Guide
8ce2aaa 
Partial Issue Resolved:
opensearch-project#9642

Signed-off-by: Anan Zhuang <[email protected]>
@ananzh ananzh marked this pull request as ready for review April 3, 2025 19:00
opensearch-changeset-bot bot added a commit to ananzh/OpenSearch-Dashboards that referenced this pull request Apr 3, 2025
@opensearch-changeset-bot
Changeset file for PR opensearch-project#9654 created/updated
9c4b9ab
@ananzh ananzh requested review from Maosaic and wanglam as code owners April 3, 2025 19:00
angle943
angle943 previously approved these changes Apr 3, 2025
View reviewed changes
@ananzh ananzh mentioned this pull request Apr 3, 2025
Closed
1 task
kavilla
kavilla reviewed Apr 3, 2025
View reviewed changes
docs/_sidebar.md Outdated
@@ -189,6 +189,7 @@
- scripts
- [README](../scripts/README.md)
- [DOCS_README](DOCS_README.md)
- [Monaco editor migration guide](monaco-editor-migration-guide.md)
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

should we consider creating a packages folder similar to the plugins folder? i think the root level of the docs folder might filling up

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

good point! I will update.

kavilla
kavilla reviewed Apr 3, 2025
View reviewed changes
docs/monaco-editor-migration-guide.md Outdated
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

could this be converted into snake case to match the other file casing?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

my bad. will change.

kavilla
kavilla reviewed Apr 3, 2025
View reviewed changes
docs/monaco-editor-migration-guide.md Outdated
@@ -0,0 +1,279 @@
# Monaco Editor Migration Guide

This document provides detailed information about the API changes between monaco-editor 0.17.0 and 0.52.0, and offers guidance for plugin developers who need to adapt to these changes.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

super nit picky: would it make sense if match the consistency in the in saying CodeEditor and monaco-editor. Like we pick either Monaco Editor and Code Editor or code-editor monaco-editor.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Will check and update

kavilla
kavilla reviewed Apr 3, 2025
View reviewed changes
docs/monaco-editor-migration-guide.md Outdated

## Best Practices

1. **Use the CodeEditor Component**: Whenever possible, use the CodeEditor component provided by OpenSearch Dashboards rather than directly using monaco-editor.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

100% agree to this be i think the code editor's readme is a little bit buried. should we add another section giving a quick explanation of the code editor. It's purposes, how a plugin can use it, and the benefits of using it?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Will add a new section

@ananzh
fix PR comment
a65ff27 
Signed-off-by: Anan Zhuang <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@kavilla kavilla kavilla left review comments

@ruchidh ruchidh ruchidh approved these changes

@angle943 angle943 angle943 left review comments

@AMoo-Miki AMoo-Miki Awaiting requested review from AMoo-Miki AMoo-Miki is a code owner

@ashwin-pc ashwin-pc Awaiting requested review from ashwin-pc ashwin-pc is a code owner

@joshuarrrr joshuarrrr Awaiting requested review from joshuarrrr joshuarrrr is a code owner

@abbyhu2000 abbyhu2000 Awaiting requested review from abbyhu2000 abbyhu2000 is a code owner

@zengyan-amazon zengyan-amazon Awaiting requested review from zengyan-amazon zengyan-amazon is a code owner

@zhongnansu zhongnansu Awaiting requested review from zhongnansu zhongnansu is a code owner

@manasvinibs manasvinibs Awaiting requested review from manasvinibs manasvinibs is a code owner

@ZilongX ZilongX Awaiting requested review from ZilongX ZilongX is a code owner

@Flyingliuhub Flyingliuhub Awaiting requested review from Flyingliuhub Flyingliuhub is a code owner

@curq curq Awaiting requested review from curq curq is a code owner

@bandinib-amzn bandinib-amzn Awaiting requested review from bandinib-amzn bandinib-amzn is a code owner

@SuZhou-Joe SuZhou-Joe Awaiting requested review from SuZhou-Joe SuZhou-Joe is a code owner

@ruanyl ruanyl Awaiting requested review from ruanyl ruanyl is a code owner

@BionIT BionIT Awaiting requested review from BionIT BionIT is a code owner

@xinruiba xinruiba Awaiting requested review from xinruiba xinruiba is a code owner

@zhyuanqi zhyuanqi Awaiting requested review from zhyuanqi zhyuanqi is a code owner

@mengweieric mengweieric Awaiting requested review from mengweieric mengweieric is a code owner

@LDrago27 LDrago27 Awaiting requested review from LDrago27 LDrago27 is a code owner

@virajsanghvi virajsanghvi Awaiting requested review from virajsanghvi virajsanghvi is a code owner

@sejli sejli Awaiting requested review from sejli sejli is a code owner

@joshuali925 joshuali925 Awaiting requested review from joshuali925 joshuali925 is a code owner

@huyaboo huyaboo Awaiting requested review from huyaboo huyaboo is a code owner

@Maosaic Maosaic Awaiting requested review from Maosaic Maosaic is a code owner

@wanglam wanglam Awaiting requested review from wanglam wanglam is a code owner

At least 2 approving reviews are required to merge this pull request.

Assignees
No one assigned
Labels
autocomplete improvement distinguished-contributor v3.0.0
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
4 participants
@ananzh @angle943 @ruchidh @kavilla