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

Make generated type docs more explorable #47069

Merged
merged 7 commits into from
Oct 15, 2019
Merged

Make generated type docs more explorable #47069

merged 7 commits into from
Oct 15, 2019

Conversation

joshdover
Copy link
Contributor

@joshdover joshdover commented Oct 1, 2019 •
edited
Loading

Summary

Depends on #47074

This makes some changes to how our Core types are defined in order to make the generated TSDocs easier to link to and between.

  • Add separate named interface for CoreSetup.http and CoreSetup.elasticsearch
    • This follows the same pattern used for ApplicationService which makes explicit the differences between the internal version of the interface and the interface exposed to plugins.
    • This creates an actual doc page we can link to. The nested interface before did not show any doc comments.
  • Add more links between interfaces
    • I added more {@link Type} directives to make navigating the docs much easier.
  • Added some missing TSDocs strings

Checklist

Use strikethroughs to remove checklist items you don't feel are applicable to this PR.

For maintainers

@elasticmachine
Copy link
Contributor

💔 Build Failed

@elasticmachine
Copy link
Contributor

💔 Build Failed

@elasticmachine
Copy link
Contributor

💔 Build Failed

@joshdover joshdover force-pushed the np/linkable-types branch 2 times, most recently from ac3ef5f to 4bfefbe Compare October 7, 2019 19:00
@elasticmachine
Copy link
Contributor

💚 Build Succeeded

@elasticmachine
Copy link
Contributor

💚 Build Succeeded

@joshdover joshdover marked this pull request as ready for review October 7, 2019 20:55
@joshdover joshdover requested review from a team as code owners October 7, 2019 20:55
@joshdover joshdover added Feature:New Platform release_note:skip Skip the PR/issue when compiling release notes Team:Core Core services & architecture: plugins, logging, config, saved objects, http, ES client, i18n, etc v7.5.0 labels Oct 7, 2019
@elasticmachine
Copy link
Contributor

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

rudolf
rudolf previously requested changes Oct 8, 2019
View reviewed changes
Copy link
Contributor

@rudolf rudolf left a comment

Choose a reason for hiding this comment

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

So much docs 😍

src/core/public/notifications/toasts/toasts_api.tsx Show resolved Hide resolved
src/core/public/public.api.md Outdated Show resolved Hide resolved
src/core/public/public.api.md Outdated Show resolved Hide resolved
src/core/public/http/types.ts Outdated Show resolved Hide resolved
src/core/server/http/types.ts Outdated Show resolved Hide resolved
src/core/server/http/types.ts Outdated Show resolved Hide resolved
src/core/server/elasticsearch/types.ts Outdated Show resolved Hide resolved
@joshdover joshdover requested a review from rudolf October 8, 2019 16:46
@elasticmachine
Copy link
Contributor

💚 Build Succeeded

@joshdover joshdover mentioned this pull request Oct 8, 2019
Merged
7 tasks
rudolf
rudolf approved these changes Oct 11, 2019
View reviewed changes
src/core/public/http/types.ts Show resolved Hide resolved
src/core/public/notifications/toasts/toasts_api.tsx Outdated
export type ToastInput = string | ToastInputFields | Promise<ToastInputFields>;

/**
* Options available for {@link IToast} APIs.
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
* Options available for {@link IToast} APIs.
* Options available for {@link IToasts} APIs.

@joshdover joshdover requested a review from a team as a code owner October 14, 2019 20:12
@elasticmachine
Copy link
Contributor

💚 Build Succeeded

@joshdover joshdover removed the request for review from a team October 15, 2019 15:08
@elasticmachine
Copy link
Contributor

💚 Build Succeeded

@joshdover joshdover merged commit 01ac90f into elastic:master Oct 15, 2019
@joshdover joshdover deleted the np/linkable-types branch October 15, 2019 16:53
@joshdover joshdover mentioned this pull request Oct 15, 2019
Merged
joshdover added a commit to joshdover/kibana that referenced this pull request Oct 15, 2019
@joshdover
Make generated type docs more explorable (elastic#47069)
5a337f2
joshdover added a commit that referenced this pull request Oct 15, 2019
@joshdover
[7.x] Make generated type docs more explorable (#47069) (#48252)
82fc260
@joshdover joshdover mentioned this pull request Oct 18, 2019
Closed
14 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@rudolf rudolf rudolf approved these changes

Assignees
No one assigned
Labels
Feature:New Platform release_note:skip Skip the PR/issue when compiling release notes Team:Core Core services & architecture: plugins, logging, config, saved objects, http, ES client, i18n, etc v7.5.0
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@joshdover @elasticmachine @rudolf