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

Adapt api-extractor to allow generating documentation from re-exported types #77529

Closed
pgayvallet opened this issue Sep 15, 2020 · 3 comments
Closed

Adapt api-extractor to allow generating documentation from re-exported types #77529

pgayvallet opened this issue Sep 15, 2020 · 3 comments
Labels
discuss Team:Core Core services & architecture: plugins, logging, config, saved objects, http, ES client, i18n, etc

Comments

@pgayvallet
Copy link
Contributor

With #76874, we started to move some base types from core to packages. However api-extractor does not generate documentation for re-exported type, causing core documentation to be incomplete, and links to types moved to packages to be broken.

We need to find a way to allow this. One option would probably be to contribute upstream.

More context: #76874 (comment)
@pgayvallet pgayvallet added discuss Team:Core Core services & architecture: plugins, logging, config, saved objects, http, ES client, i18n, etc labels Sep 15, 2020
@elasticmachine
Copy link
Contributor

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

@pgayvallet pgayvallet mentioned this issue Sep 15, 2020
Merged
2 tasks
@joshdover
Copy link
Contributor

@stacey-gammon Do you think we should close this issue now that we're moving forward with the ts-morph implementation?

@pgayvallet
Copy link
Contributor Author

Given we're planning on getting rid of api-extractor for Core's generated doc, I'll go ahead and close this.

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

No branches or pull requests
3 participants
@pgayvallet @joshdover @elasticmachine