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

Plugin introduction doc improvements #90502

Merged

Conversation

stacey-gammon
Copy link
Contributor

@stacey-gammon stacey-gammon commented Feb 5, 2021

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.

Screen Shot 2021-02-05 at 1 59 39 PM

After

Put the code samples into a plugin tutorial

Screen Shot 2021-02-05 at 2 34 24 PM

Clean up and add some extra content on the intro

Screen Shot 2021-02-05 at 2 34 29 PM

Added content on extensions and registries as these are basic pluggability concepts and words we use a lot.

Screen Shot 2021-02-05 at 2 38 20 PM

Screen Shot 2021-02-05 at 2 39 23 PM

Copy link
Contributor

@alexh97 alexh97 left a 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.

@stacey-gammon stacey-gammon marked this pull request as ready for review February 8, 2021 19:36
@stacey-gammon
Copy link
Contributor Author

@elasticmachine merge upstream

@stacey-gammon stacey-gammon added release_note:skip Skip the PR/issue when compiling release notes v7.12.0 v8.0.0 auto-backport Deprecated - use backport:version if exact versions are needed labels Feb 8, 2021
Copy link
Contributor

@rudolf rudolf left a 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

dev_docs/kibana_platform_plugin_intro.mdx Outdated Show resolved Hide resolved
dev_docs/kibana_platform_plugin_intro.mdx Outdated Show resolved Hide resolved
dev_docs/kibana_platform_plugin_intro.mdx Outdated Show resolved Hide resolved
@kibanamachine
Copy link
Contributor

💚 Build Succeeded

Metrics [docs]

✅ unchanged

History

To update your PR or re-run it, just comment with:
@elasticmachine merge upstream

@kibanamachine
Copy link
Contributor

Backport result

{"level":"info","message":"POST https://api.github.com/graphql (status: 200)"}
{"level":"info","message":"POST https://api.github.com/graphql (status: 200)"}
{"meta":{"labels":["Project:DevDocs","auto-backport","docs","release_note:skip","v7.12.0","v8.0.0"],"branchLabelMapping":{"^v8.0.0$":"master","^v7.12.0$":"7.x","^v(\\d+).(\\d+).\\d+$":"$1.$2"},"existingTargetPullRequests":[]},"level":"info","message":"Inputs when calculating target branches:"}
{"meta":["7.x"],"level":"info","message":"Target branches inferred from labels:"}
{"meta":{"killed":false,"code":2,"signal":null,"cmd":"git remote rm kibanamachine","stdout":"","stderr":"error: No such remote: 'kibanamachine'\n"},"level":"info","message":"exec error 'git remote rm kibanamachine':"}
{"meta":{"killed":false,"code":2,"signal":null,"cmd":"git remote rm elastic","stdout":"","stderr":"error: No such remote: 'elastic'\n"},"level":"info","message":"exec error 'git remote rm elastic':"}
{"level":"info","message":"Backporting [{\"sourceBranch\":\"master\",\"targetBranchesFromLabels\":[\"7.x\"],\"sha\":\"10adb72ddbf56b7d3a060315b9559900bea2adfc\",\"formattedMessage\":\"Plugin introduction doc improvements (#90502)\",\"originalMessage\":\"Plugin introduction doc improvements (#90502)\\n\\n* More plugin docs improvements\\r\\n\\r\\n* remove speculation about the future\\r\\n\\r\\n* remove registries section\\r\\n\\r\\nCo-authored-by: Kibana Machine <42973632+kibanamachine@users.noreply.github.com>\",\"pullNumber\":90502,\"existingTargetPullRequests\":[]}] to 7.x"}

Backporting to 7.x:
{"level":"info","message":"Backporting via filesystem"}
{"level":"info","message":"Creating PR with title: \"[7.x] Plugin introduction doc improvements (#90502)\". kibanamachine:backport/7.x/pr-90502 -> 7.x"}
{"level":"info","message":"POST /repos/elastic/kibana/pulls - 201 in 1138ms"}
{"level":"info","message":"Adding assignees to #90854: stacey-gammon"}
{"level":"info","message":"POST /repos/elastic/kibana/issues/90854/assignees - 201 in 656ms"}
{"level":"info","message":"Adding labels: backport"}
{"level":"info","message":"POST /repos/elastic/kibana/issues/90854/labels - 200 in 514ms"}
View pull request: https://github.com/elastic/kibana/pull/90854

kibanamachine added a commit to kibanamachine/kibana that referenced this pull request Feb 9, 2021
* More plugin docs improvements

* remove speculation about the future

* remove registries section

Co-authored-by: Kibana Machine <42973632+kibanamachine@users.noreply.github.com>
stacey-gammon added a commit that referenced this pull request Feb 10, 2021
* More plugin docs improvements

* remove speculation about the future

* remove registries section

Co-authored-by: Kibana Machine <42973632+kibanamachine@users.noreply.github.com>

Co-authored-by: Stacey Gammon <gammon@elastic.co>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
auto-backport Deprecated - use backport:version if exact versions are needed DevDocs docs release_note:skip Skip the PR/issue when compiling release notes v7.12.0 v8.0.0
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants