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.

Sign up for GitHub

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

Jump to bottom

[App Arch] Plugin cleanup #55919

Closed
14 tasks
lukeelmers opened this issue Jan 24, 2020 · 2 comments
Closed
14 tasks

[App Arch] Plugin cleanup #55919

lukeelmers opened this issue Jan 24, 2020 · 2 comments
Labels
Feature:Development impact:low Addressing this issue will have a low level of impact on the quality/strength of our product. loe:small Small Level of Effort Meta technical debt Improvement of the software architecture and operational architecture

Comments

@lukeelmers
Copy link
Member

lukeelmers commented Jan 24, 2020 •
edited
Loading

This issue tracks technical debt accumulated over the course of new platform migration. Most tasks here involve cleaning up the structure & conventions in each of our plugins to ensure consistency.

  • Plugin ids are camelCase. Paths can be omitted as they are automatically converted to camelCase.
  • x-pack plugins which extend OSS functionality have consistent names (e.g. data, data_enhanced)
  • Every plugin has a basic README which at least describes the services it encompasses at a high level
  • Where possible, replace usages of createGetterSetter with core.getStartServices (for async items)
  • Expose uiSettings via lifecycle contracts
  • Convert uiSettings links to use docLinks
  • export * from ... is removed from root server and public index files to ensure private interfaces are not leaking into the public contract
  • Consistent conventions for exporting static code / types
  • Consistent naming of plugin contract interfaces (e.g. DataSetup, DataStart)
  • Ensure nobody is importing static code from /common directories
  • Definition convention—postfix convenience types used to register something into registries with *Definition.
    • Examples:
      • ExpressionFunctionDefinition
      • ActionDefinition
  • Consistent structure / naming of mocks
  • old paths in i18nrc.json are removed
  • CODEOWNERS & paths-labeller is updated for accuracy and to remove legacy items
@elasticmachine
Copy link
Contributor

Pinging @elastic/kibana-app-arch (Team:AppArch)

This was referenced Jan 24, 2020
Closed
Merged
This was referenced Mar 19, 2020
Closed
Closed
@streamich streamich mentioned this issue Mar 25, 2020
Merged
@lukeelmers lukeelmers mentioned this issue Mar 31, 2020
Closed
@lukeelmers lukeelmers added Meta technical debt Improvement of the software architecture and operational architecture and removed chore labels May 20, 2020
@lukeelmers lukeelmers changed the title [App Arch] New platform plugin cleanup [App Arch] Plugin cleanup Jun 8, 2020
@exalate-issue-sync exalate-issue-sync bot added impact:low Addressing this issue will have a low level of impact on the quality/strength of our product. loe:small Small Level of Effort labels Jun 21, 2021
@lukeelmers
Copy link
Member Author

@ppisljar I just stumbled across this one and I'm guessing it isn't relevant anymore, so I'll go ahead and close it.

@lukeelmers lukeelmers closed this as not planned Won't fix, can't repro, duplicate, stale May 10, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
Feature:Development impact:low Addressing this issue will have a low level of impact on the quality/strength of our product. loe:small Small Level of Effort Meta technical debt Improvement of the software architecture and operational architecture
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
3 participants
@lukeelmers @ppisljar @elasticmachine