Update core architecture docs #164120
Merged
Update core architecture docs #164120
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
TinaHeiligers
added
chore
Team:Core
|
Pinging @elastic/kibana-core (Team:Core) |
|
Documentation preview: |
|
@elasticmachine merge upstream |
afharo
reviewed
Aug 17, 2023
|
@elasticmachine merge upstream |
TinaHeiligers
commented
Aug 17, 2023
| @@ -12,7 +12,7 @@ The service allows plugins to: | |||
| * to execute custom logic on an incoming request or server response. | |||
| * implement custom authentication and authorization strategy. | |||
|
|
|||
| See {kib-repo}blob/{branch}/docs/development/core/server/kibana-plugin-core-server.httpservicesetup.md[HTTP service API docs] | |||
| Refer to {kib-repo}/blob/8.9/packages/core/http/core-http-server/src/http_contract.ts[HTTP service contract types]. | |||
There was a problem hiding this comment.
Points to concrete branch to mitigate broken links in the immediate term caused by code that's changed location
TinaHeiligers
commented
Aug 17, 2023
| @@ -64,4 +64,4 @@ async function fetchData<ResponseType>(core: CoreStart) { | |||
| ); | |||
| } | |||
| ---- | |||
| See {kib-repo}blob/{branch}/docs/development/core/public/kibana-plugin-core-public.httpsetup.md[for all available API]. | |||
| Refer to {kib-repo}/blob/8.9/packages/core/http/core-http-browser/src/types.ts[the client-side APIs]. | |||
There was a problem hiding this comment.
@afharo I replaced all the "See" with "Refer to" in the files the PR touches, thanks for the reminder! Could you take another look please?
TinaHeiligers
commented
Aug 17, 2023
| {kib-repo}blob/{branch}/docs/development/core/server/kibana-plugin-core-server.requesthandler.md[the | ||
| request handler interface.] | ||
| as | ||
| {kib-repo}/blob/8.9/packages/core/http/core-http-server/src/router/request_handler.ts[the request handler interface]. |
There was a problem hiding this comment.
Refer to concrete branch rather than the current, main branch
TinaHeiligers
commented
Aug 17, 2023
| The | ||
| {kib-repo}blob/{branch}/docs/development/core/server/kibana-plugin-core-server.requesthandlercontext.md[request | ||
| handler context] exposes the following scoped *core* services: | ||
| The {kib-repo}/blob/8.9/packages/core/http/core-http-server/src/router/request_handler.ts[request handler context] exposes the following scoped *core* services: |
There was a problem hiding this comment.
Replace main branch with concrete branch here and in other files this PR touches
TinaHeiligers
commented
Aug 17, 2023
|
@elasticmachine merge upstream |
💛 Build succeeded, but was flaky
Failed CI StepsMetrics [docs]
History
To update your PR or re-run it, just comment with: |
|
@elasticmachine merge upstream |
amyjtechwriter
approved these changes
Aug 21, 2023
Co-authored-by: amyjtechwriter <[email protected]>
Co-authored-by: amyjtechwriter <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
fix #164121
Updates broken links in core docs, and adds a package describing the package structure of core code.
Note in main entry point to the new page:
The new page briefly describes the change in how we implement Core:
Checklist
Delete any items that are not applicable to this PR.