[Docs] Onboarding docs #10547
Open
[Docs] Onboarding docs #10547
+14,118
−55
Conversation
This file contains hidden or 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
…system and UI framework - Introduced a new document detailing the OpenSearch Dashboards Plugin System, covering key concepts, plugin architecture, lifecycle phases, APIs, and best practices. - Added a new document on the OpenSearch Dashboards UI Framework and Component System, outlining core technologies, component patterns, state management, routing, theming, accessibility, and best practices for UI development.
- Created a comprehensive guide for plugin development templates, including basic and advanced templates, common patterns, configuration examples, testing templates, and best practices. - Introduced a troubleshooting guide covering common development issues, build errors, runtime errors, plugin development issues, performance problems, debugging techniques, and deployment issues.
- Added a link to the Developer docs website in the main README. - Restructured the sidebar navigation for onboarding documentation, improving organization and accessibility. - Updated links in onboarding documents to ensure consistency and accuracy. - Improved the generate_docs_sidebar script to handle directory structures more effectively, allowing for better expandable sections in the sidebar. - Corrected references in various onboarding documents to point to the correct paths for API, configuration, and troubleshooting guides.
ashwin-pc
requested review from
ananzh,
kavilla,
AMoo-Miki,
joshuarrrr,
abbyhu2000,
zengyan-amazon,
zhongnansu,
manasvinibs,
ZilongX,
Flyingliuhub,
curq,
bandinib-amzn,
SuZhou-Joe,
ruanyl,
BionIT,
xinruiba,
zhyuanqi,
mengweieric,
LDrago27,
virajsanghvi,
sejli,
joshuali925,
huyaboo,
angle943,
Maosaic,
wanglam and
d-buckner
as code owners
ashwin-pc
added
docs
❌ Empty Changelog SectionThe Changelog section in your PR description is empty. Please add a valid changelog entry or entries. If you did add a changelog entry, check to make sure that it was not accidentally included inside the comment block in the Changelog section. |
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #10547 +/- ##
==========================================
- Coverage 62.06% 60.20% -1.87%
==========================================
Files 4293 4299 +6
Lines 109997 114900 +4903
Branches 18131 18620 +489
==========================================
+ Hits 68275 69176 +901
- Misses 37069 41029 +3960
- Partials 4653 4695 +42
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
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.
Description
Issues Resolved
Screenshot
Testing the changes
Changelog
Check List
yarn test:jestyarn test:jest_integration