[docs] Convert migration guide to asciidoc #82600

mshustov · 2020-11-04T13:12:56Z

Summary

Closes #75786
This PR:

converts Migration & Migration_example guides to *.asciidoc
provides the minimal set of docs for the core services
adds links to core & plugin docs whenever possible
how to develop, build & install a plugin

elasticmachine · 2020-11-04T14:44:06Z

Pinging @elastic/kibana-platform (Team:Platform)

rudolf

Added a lot of comments 😅 but I think it's worth spending a bit of extra effort on these public docs.

docs/developer/architecture/kibana-platform-plugin-api.asciidoc

docs/developer/architecture/index.asciidoc

docs/developer/architecture/kibana-platform-plugin-api.asciidoc

docs/developer/architecture/core/core-api.asciidoc

Co-authored-by: Rudolf Meijering <skaapgif@gmail.com>

gchaps

LGTM

docs/developer/plugin/migrating-legacy-plugins.asciidoc

Co-authored-by: gchaps <33642766+gchaps@users.noreply.github.com>

docs/developer/plugin/migrating-legacy-plugins-examples.asciidoc

Co-authored-by: gchaps <33642766+gchaps@users.noreply.github.com>

@gchaps

* Initial conversion to asciidoc * Update and split migration guide * Convert MIGRATION_EXAMPLES to asciidoc * build with --focus flag * convert migration guide to asciidoc * cleanup migration_examples * fix wrong Heading size * update links in docs * Apply suggestions from code review Co-authored-by: Rudolf Meijering <skaapgif@gmail.com> * Apply suggestions from code review Co-authored-by: Rudolf Meijering <skaapgif@gmail.com> * add tooling section * explain purpose of each lifecycle method * cleanup docs * cleanup p2 * fix wrong link * resturcture core docs * fix wrong link * update missing links * Apply suggestions from code review Co-authored-by: gchaps <33642766+gchaps@users.noreply.github.com> * address comments * add a commenta about plugin-helpers preconfigured * improve density of tables * fix lik * remove links to the migration guide * address comments * Apply suggestions from code review Co-authored-by: gchaps <33642766+gchaps@users.noreply.github.com> * address @gchaps comments * Apply suggestions from code review Co-authored-by: gchaps <33642766+gchaps@users.noreply.github.com> * change format of ES client change list Co-authored-by: Josh Dover <me@joshdover.com> Co-authored-by: Rudolf Meijering <skaapgif@gmail.com> Co-authored-by: gchaps <33642766+gchaps@users.noreply.github.com> # Conflicts: # docs/developer/architecture/core/saved-objects-service.asciidoc # docs/developer/architecture/index.asciidoc # src/core/MIGRATION.md # src/core/README.md

@gchaps

* Initial conversion to asciidoc * Update and split migration guide * Convert MIGRATION_EXAMPLES to asciidoc * build with --focus flag * convert migration guide to asciidoc * cleanup migration_examples * fix wrong Heading size * update links in docs * Apply suggestions from code review Co-authored-by: Rudolf Meijering <skaapgif@gmail.com> * Apply suggestions from code review Co-authored-by: Rudolf Meijering <skaapgif@gmail.com> * add tooling section * explain purpose of each lifecycle method * cleanup docs * cleanup p2 * fix wrong link * resturcture core docs * fix wrong link * update missing links * Apply suggestions from code review Co-authored-by: gchaps <33642766+gchaps@users.noreply.github.com> * address comments * add a commenta about plugin-helpers preconfigured * improve density of tables * fix lik * remove links to the migration guide * address comments * Apply suggestions from code review Co-authored-by: gchaps <33642766+gchaps@users.noreply.github.com> * address @gchaps comments * Apply suggestions from code review Co-authored-by: gchaps <33642766+gchaps@users.noreply.github.com> * change format of ES client change list Co-authored-by: Josh Dover <me@joshdover.com> Co-authored-by: Rudolf Meijering <skaapgif@gmail.com> Co-authored-by: gchaps <33642766+gchaps@users.noreply.github.com> # Conflicts: # docs/developer/architecture/core/saved-objects-service.asciidoc # docs/developer/architecture/index.asciidoc # src/core/MIGRATION.md # src/core/README.md

@gchaps

* Initial conversion to asciidoc * Update and split migration guide * Convert MIGRATION_EXAMPLES to asciidoc * build with --focus flag * convert migration guide to asciidoc * cleanup migration_examples * fix wrong Heading size * update links in docs * Apply suggestions from code review Co-authored-by: Rudolf Meijering <skaapgif@gmail.com> * Apply suggestions from code review Co-authored-by: Rudolf Meijering <skaapgif@gmail.com> * add tooling section * explain purpose of each lifecycle method * cleanup docs * cleanup p2 * fix wrong link * resturcture core docs * fix wrong link * update missing links * Apply suggestions from code review Co-authored-by: gchaps <33642766+gchaps@users.noreply.github.com> * address comments * add a commenta about plugin-helpers preconfigured * improve density of tables * fix lik * remove links to the migration guide * address comments * Apply suggestions from code review Co-authored-by: gchaps <33642766+gchaps@users.noreply.github.com> * address @gchaps comments * Apply suggestions from code review Co-authored-by: gchaps <33642766+gchaps@users.noreply.github.com> * change format of ES client change list Co-authored-by: Josh Dover <me@joshdover.com> Co-authored-by: Rudolf Meijering <skaapgif@gmail.com> Co-authored-by: gchaps <33642766+gchaps@users.noreply.github.com> # Conflicts: # docs/developer/architecture/core/saved-objects-service.asciidoc # docs/developer/architecture/index.asciidoc # src/core/MIGRATION.md # src/core/README.md

@gchaps

* Initial conversion to asciidoc * Update and split migration guide * Convert MIGRATION_EXAMPLES to asciidoc * build with --focus flag * convert migration guide to asciidoc * cleanup migration_examples * fix wrong Heading size * update links in docs * Apply suggestions from code review Co-authored-by: Rudolf Meijering <skaapgif@gmail.com> * Apply suggestions from code review Co-authored-by: Rudolf Meijering <skaapgif@gmail.com> * add tooling section * explain purpose of each lifecycle method * cleanup docs * cleanup p2 * fix wrong link * resturcture core docs * fix wrong link * update missing links * Apply suggestions from code review Co-authored-by: gchaps <33642766+gchaps@users.noreply.github.com> * address comments * add a commenta about plugin-helpers preconfigured * improve density of tables * fix lik * remove links to the migration guide * address comments * Apply suggestions from code review Co-authored-by: gchaps <33642766+gchaps@users.noreply.github.com> * address @gchaps comments * Apply suggestions from code review Co-authored-by: gchaps <33642766+gchaps@users.noreply.github.com> * change format of ES client change list Co-authored-by: Josh Dover <me@joshdover.com> Co-authored-by: Rudolf Meijering <skaapgif@gmail.com> Co-authored-by: gchaps <33642766+gchaps@users.noreply.github.com> # Conflicts: # docs/developer/architecture/core/saved-objects-service.asciidoc # docs/developer/architecture/index.asciidoc # src/core/MIGRATION.md # src/core/README.md

marius-dr · 2020-12-28T12:40:25Z

The old link should still have a placeholder that link people to the correct place. There are links to the guide in the blog post that explains the new architecture.

joshdover and others added 7 commits October 15, 2020 16:16

Initial conversion to asciidoc

1ef8237

Update and split migration guide

3d827bb

Convert MIGRATION_EXAMPLES to asciidoc

c2811cc

Merge branch 'master' into pr/80784

79a9d9a

build with --focus flag

d5511b4

convert migration guide to asciidoc

cd8586b

cleanup migration_examples

b44e946

This was referenced Nov 4, 2020

Convert migration guide to asciidoc #80784

Closed

Write basic documentation for Kibana Development Platform #75786

Closed

mshustov added docs Team:Core Core services & architecture: plugins, logging, config, saved objects, http, ES client, i18n, etc v7.10.0 v8.0.0 labels Nov 4, 2020

fix wrong Heading size

ef52c00

mshustov marked this pull request as ready for review November 4, 2020 14:44

mshustov requested a review from a team as a code owner November 4, 2020 14:44

mshustov added the release_note:skip Skip the PR/issue when compiling release notes label Nov 5, 2020

update links in docs

bba76b0

pgayvallet approved these changes Nov 5, 2020

View reviewed changes

mshustov changed the title ~~Convert migration guide to asciidoc~~ [docs] Convert migration guide to asciidoc Nov 6, 2020

rudolf reviewed Nov 6, 2020

View reviewed changes

mshustov and others added 8 commits November 8, 2020 11:04

Apply suggestions from code review

5f0fb90

Co-authored-by: Rudolf Meijering <skaapgif@gmail.com>

Apply suggestions from code review

1d8bdc0

Co-authored-by: Rudolf Meijering <skaapgif@gmail.com>

add tooling section

0daa5d5

Merge remote-tracking branch 'origin/pr/80784' into pr/80784

32aec24

explain purpose of each lifecycle method

c3f7703

cleanup docs

79c374a

cleanup p2

e28abd8

fix wrong link

1d369e9

mshustov added 3 commits November 11, 2020 11:02

add a commenta about plugin-helpers preconfigured

58d0b26

improve density of tables

510b01b

fix lik

0ae5731

mshustov requested a review from gchaps November 11, 2020 08:45

rudolf approved these changes Nov 11, 2020

View reviewed changes

remove links to the migration guide

e128d9b

mshustov mentioned this pull request Nov 12, 2020

[plugin-helpers] improve 3rd party KP plugin support #75019

Merged

LeeDr added v7.10.1 and removed v7.10.0 labels Nov 12, 2020

Merge branch 'master' into pr/80784

9628fb9

gchaps approved these changes Nov 16, 2020

View reviewed changes

address comments

b20d6af

rudolf approved these changes Nov 19, 2020

View reviewed changes

gchaps reviewed Nov 20, 2020

View reviewed changes

mshustov and others added 3 commits November 20, 2020 19:27

Apply suggestions from code review

8e85f83

Co-authored-by: gchaps <33642766+gchaps@users.noreply.github.com>

Merge remote-tracking branch 'origin/pr/80784' into pr/80784

4453bfb

address @gchaps comments

eed5920

gchaps reviewed Nov 23, 2020

View reviewed changes

mshustov and others added 3 commits November 24, 2020 11:10

Apply suggestions from code review

091ab65

Co-authored-by: gchaps <33642766+gchaps@users.noreply.github.com>

Merge remote-tracking branch 'origin/pr/80784' into pr/80784

86c6beb

change format of ES client change list

b44350c

mshustov merged commit ab8a2f7 into elastic:master Nov 24, 2020

mshustov deleted the pr/80784 branch November 24, 2020 08:46

mshustov mentioned this pull request Nov 24, 2020

[7.x] [docs] Convert migration guide to asciidoc (#82600) #84180

Merged

mshustov mentioned this pull request Nov 24, 2020

[7.10] [docs] Convert migration guide to asciidoc (#82600) #84181

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[docs] Convert migration guide to asciidoc #82600

[docs] Convert migration guide to asciidoc #82600

mshustov commented Nov 4, 2020 •

edited

Loading

elasticmachine commented Nov 4, 2020

rudolf left a comment

gchaps left a comment

marius-dr commented Dec 28, 2020

[docs] Convert migration guide to asciidoc #82600

[docs] Convert migration guide to asciidoc #82600

Conversation

mshustov commented Nov 4, 2020 • edited Loading

Summary

elasticmachine commented Nov 4, 2020

rudolf left a comment

Choose a reason for hiding this comment

gchaps left a comment

Choose a reason for hiding this comment

marius-dr commented Dec 28, 2020

mshustov commented Nov 4, 2020 •

edited

Loading