Kibana: Improve Migration Guide

[joshdover]

This is an issue to track improvements that should be made to the Migration Guide and accompanying docs.

The goal of the guide is to provide all necessary guidance to successfully move a legacy plugin to the New Platform.

Improvements

• [x] Add links to Core API docs (#46661)
• [x] Add table of uiExports (#46661)
• [ ] Add more details and examples
  
  
  
  • [ ] "Browser-side plan of action" section
  
  
  • [ ] How to actually move code to a NP-plugin proper (last step of migration)
  
  
• [ ] Logging
  
  
  
  • [ ] Migration example
  
  
  • [ ] Example in TSDocs
  
  

[elasticmachine]

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

[restrry]

• [ ] How to consume core types. Meaning of src/core/server/types folder to prevent such cases https://github.com/elastic/kibana/pull/47590/files#diff-f7bc3a6feccc0d692c3f2831a40194b6L8
• [ ] Recommended folder structure on the server

[rudolf]

• [x] Fix incorrect http router shim example in MIGRATION.md (thanks @jfsiii) https://github.com/elastic/kibana/pull/48518
  // HTTP functionality from legacy platform, accessed in the NP convention, just like Elasticsearch above. core.http.route({ // note: we know routes will be created on core.http path: '/api/demo_plugin/search',

[tsullivan]

https://github.com/elastic/kibana/blob/master/src/core/MIGRATION.md#configure-plugin

In one of the code sections, there is a code comment saying ... if config is optional

The guide doesn't explain what optional config means. If there is config that has default settings, would it always exist? In other words, would a config never be optional if it has a default?

[restrry]

• [ ] Add an example of angular application usage within the new platform and what limitations it has.

[joshdover]

• [x] Add an example of how to migrate the pre option from Hapi to New Platform router (@joshdover)

[rudolf]

• [ ] Remove comments from Migration guide that core.application.register isn't available in legacy (since https://github.com/elastic/kibana/pull/46659) https://github.com/elastic/kibana/blob/bd3857a79befd9baa88e0ca76f6b1594f8716b88/src/core/MIGRATION_EXAMPLES.md#L464 https://github.com/elastic/kibana/blob/ecf8657d824e394904bb4d30e619d992a486bf0a/src/core/MIGRATION.md#L1137

[joshdover]

With the majority of teams having completed their migration I am closing this issue. Whenever we focus on moving this documentation to our public docs, we should focus on reworking this doc for 3rd party plugins.