-
Notifications
You must be signed in to change notification settings - Fork 8.3k
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
Plugin introduction doc improvements #90502
Plugin introduction doc improvements #90502
Conversation
708ea1c
to
0cc8af9
Compare
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.
I really like this direction. In general, when I'm trying to learn a new system/codebase/architecture, I want to see a very high-level description (preferably with diagrams) first. What are the major domains and building blocks? How do they relate to each other? Why should I care?
Only once I understand the big picture, do I want to dive into code examples. And then I want to use the reference once I'm actively developing.
I think this new structure works much better.
@elasticmachine merge upstream |
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.
I like the guide vs tutorial split 👍 but left some thoughts on the platform vs core distinction
…n/kibana into 2021-02-04-pluggability-101
💚 Build SucceededMetrics [docs]
History
To update your PR or re-run it, just comment with: |
Backport result
|
* More plugin docs improvements * remove speculation about the future * remove registries section Co-authored-by: Kibana Machine <[email protected]>
* More plugin docs improvements * remove speculation about the future * remove registries section Co-authored-by: Kibana Machine <[email protected]> Co-authored-by: Stacey Gammon <[email protected]>
Taking some advice from https://documentation.divio.com, I think we should pull the code snippets out of https://elasticdocstest.netlify.app/kibana-dev-docs/platform-intro and into a new tutorials section.
In addition, I added information on extensions and registries to the platform/plugin intro.
Before
This introduction file included quite a bit of code samples and details.
After
Put the code samples into a plugin tutorial
Clean up and add some extra content on the intro
Added content on extensions and registries as these are basic pluggability concepts and words we use a lot.