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

Move Kibana Platform documentation to Kibana's Developer Guide #58183

Closed
4 tasks
joshdover opened this issue Feb 20, 2020 · 8 comments
Closed
4 tasks

Move Kibana Platform documentation to Kibana's Developer Guide #58183

joshdover opened this issue Feb 20, 2020 · 8 comments
Labels
Feature:New Platform Team:Core Core services & architecture: plugins, logging, config, saved objects, http, ES client, i18n, etc

Comments

@joshdover
Copy link
Contributor

joshdover commented Feb 20, 2020

In support of #41833 and preparation for more external communications of the Kibana Platform, we should move our documentation into asciidoc. This first pass is focused only on handwritten documentation and not the generated API docs.

Docs to move:

  • src/core/MIGRATION.md
  • src/core/MIGRATION_EXAMPLES.md
  • src/core/CONVENTIONS.md
  • src/core/TESTING.md

Docs to remain:

  • src/core/CORE_CONVENTIONS.md
  • src/core/PRINCIPLES.md

I propose we create two sections under the "Developer guide" section: one for legacy plugins, one for platform plugins. We can include a high-level overview of the platform as well as these existing docs on how to migrate to it.

@joshdover joshdover self-assigned this Feb 20, 2020
@joshdover joshdover added Feature:New Platform Team:Core Core services & architecture: plugins, logging, config, saved objects, http, ES client, i18n, etc labels Feb 20, 2020
@elasticmachine
Copy link
Contributor

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

@mshustov
Copy link
Contributor

I suspect PRINCIPLES.md remains the internal documentation. Doesn't it?

@joshdover
Copy link
Contributor Author

I suspect PRINCIPLES.md remains the internal documentation. Doesn't it?

Ah yes, missed that one. Updated the description.

@joshdover
Copy link
Contributor Author

One concern that came up was the docs on elastic.co being out of sync with the repository. It turns out the docs are rebuilt and published every 30 minutes, so I do not think this is much of a concern.

@joshdover joshdover removed their assignment Dec 2, 2020
@stacey-gammon stacey-gammon changed the title Move Kibana Platform documentation to Kibana's asciidoc book Move Kibana Platform documentation to Kibana's Developer Guide Mar 3, 2022
@stacey-gammon
Copy link
Contributor

@lukeelmers - should we close this? Legacy plugins aren't really a thing anymore.

@pgayvallet
Copy link
Contributor

Is that a dupe of #57343?

@stacey-gammon
Copy link
Contributor

I changed the title yesterday, originally this issue specifically mentioned new platform (hence migrations, and migration examples - not saved object migrations but migrating from old platform to new platform). So I say we close as obsolete, but closing as a dup works fine for me too :D

@pgayvallet
Copy link
Contributor

Closing as Math.rand() > 0.5 ? "obsolete" : "duplicate"

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Feature:New Platform Team:Core Core services & architecture: plugins, logging, config, saved objects, http, ES client, i18n, etc
Projects
None yet
Development

No branches or pull requests

5 participants