Skip to content

[Canvas] Removed function reference docs generator#136955

Merged
cqliu1 merged 1 commit intoelastic:mainfrom
cqliu1:canvas/remove-docs-ref-generator
Jul 22, 2022
Merged

[Canvas] Removed function reference docs generator#136955
cqliu1 merged 1 commit intoelastic:mainfrom
cqliu1:canvas/remove-docs-ref-generator

Conversation

@cqliu1
Copy link
Copy Markdown
Contributor

@cqliu1 cqliu1 commented Jul 22, 2022

Summary

I'm removing this component that only appears in dev. I originally created this component as an easy way to generate our Canvas expression function reference docs directly from the function definitions.

The reason I'm removing this component is because it violates the no boundary crossing rule Spencer is introducing in #136911 as part of his plugin package project. Since it's just a tool visible in dev primarily by me, there is no reason it needs to be checked into main, and if necessary in the future, it should be fairly easy to create a better script for this or to restore it temporarily just to update our function docs.

There should be no user-facing changes.

Checklist

Delete any items that are not applicable to this PR.

Risk Matrix

Delete this section if it is not applicable to this PR.

Before closing this PR, invite QA, stakeholders, and other developers to identify risks that should be tested prior to the change/feature release.

When forming the risk matrix, consider some of the following examples and how they may potentially impact the change:

Risk Probability Severity Mitigation/Notes
Multiple Spaces—unexpected behavior in non-default Kibana Space. Low High Integration tests will verify that all features are still supported in non-default Kibana Space and when user switches between spaces.
Multiple nodes—Elasticsearch polling might have race conditions when multiple Kibana nodes are polling for the same tasks. High Low Tasks are idempotent, so executing them multiple times will not result in logical error, but will degrade performance. To test for this case we add plenty of unit tests around this logic and document manual testing procedure.
Code should gracefully handle cases when feature X or plugin Y are disabled. Medium High Unit tests will verify that any feature flag or plugin combination still results in our service operational.
See more potential risk examples

For maintainers

@cqliu1 cqliu1 added Team:Presentation Presentation Team for Dashboard, Input Controls, and Canvas t// loe:small Small Level of Effort release_note:skip Skip the PR/issue when compiling release notes impact:critical This issue should be addressed immediately due to a critical level of impact on the product. backport:skip This PR does not require backporting Feature:Canvas v8.4.0 labels Jul 22, 2022
@cqliu1 cqliu1 requested a review from a team as a code owner July 22, 2022 14:03
@elasticmachine
Copy link
Copy Markdown
Contributor

Pinging @elastic/kibana-presentation (Team:Presentation)

@cqliu1 cqliu1 added the review label Jul 22, 2022
Copy link
Copy Markdown
Contributor

@ThomThomson ThomThomson left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The removal of the function docs generator makes sense to me.

Just want to make double-sure that there aren't any user facing changes associated? The Help menu props changes made me think that there might be.

@kibana-ci
Copy link
Copy Markdown

💚 Build Succeeded

Metrics [docs]

Async chunks

Total size of all lazy-loaded chunks that will be downloaded as the user navigates the app

id before after diff
canvas 1.0MB 1.0MB -126.0B
Unknown metric groups

References to deprecated APIs

id before after diff
canvas 52 50 -2

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

@cqliu1 cqliu1 merged commit cf35970 into elastic:main Jul 22, 2022
@cqliu1 cqliu1 deleted the canvas/remove-docs-ref-generator branch July 22, 2022 23:17
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

backport:skip This PR does not require backporting Feature:Canvas impact:critical This issue should be addressed immediately due to a critical level of impact on the product. loe:small Small Level of Effort release_note:skip Skip the PR/issue when compiling release notes review Team:Presentation Presentation Team for Dashboard, Input Controls, and Canvas t// v8.4.0

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants