-
Notifications
You must be signed in to change notification settings - Fork 8.2k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge branch 'master' into rk/82755-profile-links
- Loading branch information
Showing
923 changed files
with
25,072 additions
and
4,154,775 deletions.
There are no files selected for viewing
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1 +1 @@ | ||
| 1.7.3 | ||
| 1.7.5 |
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,5 +1,6 @@ | ||
| .aws-config.json | ||
| .signing-config.json | ||
| /api_docs | ||
| .ackrc | ||
| /.es | ||
| /.chromium | ||
|
|
||
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
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
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
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
13 changes: 13 additions & 0 deletions
13
...elopment/core/server/kibana-plugin-core-server.pluginmanifest.servicefolders.md
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,13 @@ | ||
| <!-- Do not edit this file. It is automatically generated by API Documenter. --> | ||
|
|
||
| [Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [PluginManifest](./kibana-plugin-core-server.pluginmanifest.md) > [serviceFolders](./kibana-plugin-core-server.pluginmanifest.servicefolders.md) | ||
|
|
||
| ## PluginManifest.serviceFolders property | ||
|
|
||
| Only used for the automatically generated API documentation. Specifying service folders will cause your plugin API reference to be broken up into sub sections. | ||
|
|
||
| <b>Signature:</b> | ||
|
|
||
| ```typescript | ||
| readonly serviceFolders?: readonly string[]; | ||
| ``` |
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
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,24 @@ | ||
| [[discover-search-for-relevance]] | ||
| == Search for relevance | ||
| Sometimes you might be unsure which documents best match your question. | ||
| {es} assigns a relevancy, or score to each document, so you can | ||
| can narrow your search to the documents with the most relevant results. | ||
| The higher the score, the better it matches your query. | ||
|
|
||
| For example, suppose you have the <<gs-get-data-into-kibana, sample flights data set>>, and you're a searching for | ||
| a flight that arrived or departed from `Warsaw` or `Venice` when the weather was clear. | ||
|
|
||
| . In *Discover*, open the index pattern dropdown, and select `kibana_sample_data_flight`. | ||
| . In the query bar, click *KQL*, and switch to the <<lucene-query, Lucene query syntax>>. | ||
| . Search for `Warsaw OR Venice OR Clear`. | ||
| . If you don't see any results, open the time filter and select a time range that contains data. | ||
| . From the list of *Available fields*, add `_score` to the document table. | ||
| . In the document table, click the header for the `_score` column, and then sort the column by descending scores. | ||
| + | ||
| The results are currently sorted by first `Time`, and then by `_score`. | ||
| . To sort only by `_score`, remove the `Time` field. | ||
| + | ||
| Your table now shows documents with the best matches, from most to least relevant. | ||
| + | ||
| [role="screenshot"] | ||
| image::images/discover-search-for-relevance.png["Example of a search for relevance"] |
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
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
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
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
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
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
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
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
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,12 @@ | ||
| # Autogenerated API documentation | ||
|
|
||
| [RFC](../../../rfcs/text/0014_api_documentation.md) | ||
|
|
||
| This is an experimental api documentation system that is managed by the Kibana Tech Leads until | ||
| we determine the value of such a system and what kind of maintenance burder it will incur. | ||
|
|
||
| To generate the docs run | ||
|
|
||
| ``` | ||
| node scripts/build_api_docs | ||
| ``` |
85 changes: 85 additions & 0 deletions
85
packages/kbn-docs-utils/src/api_docs/build_api_declarations/buid_api_declaration.test.ts
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,85 @@ | ||
| /* | ||
| * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one | ||
| * or more contributor license agreements. Licensed under the Elastic License | ||
| * 2.0 and the Server Side Public License, v 1; you may not use this file except | ||
| * in compliance with, at your election, the Elastic License 2.0 or the Server | ||
| * Side Public License, v 1. | ||
| */ | ||
|
|
||
| import Path from 'path'; | ||
| import { Project, Node } from 'ts-morph'; | ||
| import { ToolingLog, KibanaPlatformPlugin } from '@kbn/dev-utils'; | ||
|
|
||
| import { TypeKind, ApiScope } from '../types'; | ||
| import { getKibanaPlatformPlugin } from '../tests/kibana_platform_plugin_mock'; | ||
| import { getDeclarationNodesForPluginScope } from '../get_declaration_nodes_for_plugin'; | ||
| import { buildApiDeclaration } from './build_api_declaration'; | ||
| import { isNamedNode } from '../tsmorph_utils'; | ||
|
|
||
| const log = new ToolingLog({ | ||
| level: 'debug', | ||
| writeTo: process.stdout, | ||
| }); | ||
|
|
||
| let nodes: Node[]; | ||
| let plugins: KibanaPlatformPlugin[]; | ||
|
|
||
| function getNodeName(node: Node): string { | ||
| return isNamedNode(node) ? node.getName() : ''; | ||
| } | ||
|
|
||
| beforeAll(() => { | ||
| const tsConfigFilePath = Path.resolve(__dirname, '../tests/__fixtures__/src/tsconfig.json'); | ||
| const project = new Project({ | ||
| tsConfigFilePath, | ||
| }); | ||
|
|
||
| plugins = [getKibanaPlatformPlugin('pluginA')]; | ||
|
|
||
| nodes = getDeclarationNodesForPluginScope(project, plugins[0], ApiScope.CLIENT, log); | ||
| }); | ||
|
|
||
| it('Test number primitive doc def', () => { | ||
| const node = nodes.find((n) => getNodeName(n) === 'aNum'); | ||
| expect(node).toBeDefined(); | ||
| const def = buildApiDeclaration(node!, plugins, log, plugins[0].manifest.id, ApiScope.CLIENT); | ||
|
|
||
| expect(def.type).toBe(TypeKind.NumberKind); | ||
| }); | ||
|
|
||
| it('Function type is exported as type with signature', () => { | ||
| const node = nodes.find((n) => getNodeName(n) === 'FnWithGeneric'); | ||
| expect(node).toBeDefined(); | ||
| const def = buildApiDeclaration(node!, plugins, log, plugins[0].manifest.id, ApiScope.CLIENT); | ||
| expect(def).toBeDefined(); | ||
| expect(def?.type).toBe(TypeKind.TypeKind); | ||
| expect(def?.signature?.length).toBeGreaterThan(0); | ||
| }); | ||
|
|
||
| it('Test Interface Kind doc def', () => { | ||
| const node = nodes.find((n) => getNodeName(n) === 'ExampleInterface'); | ||
| expect(node).toBeDefined(); | ||
| const def = buildApiDeclaration(node!, plugins, log, plugins[0].manifest.id, ApiScope.CLIENT); | ||
|
|
||
| expect(def.type).toBe(TypeKind.InterfaceKind); | ||
| expect(def.children).toBeDefined(); | ||
| expect(def.children!.length).toBe(3); | ||
| }); | ||
|
|
||
| it('Test union export', () => { | ||
| const node = nodes.find((n) => getNodeName(n) === 'aUnionProperty'); | ||
| expect(node).toBeDefined(); | ||
| const def = buildApiDeclaration(node!, plugins, log, plugins[0].manifest.id, ApiScope.CLIENT); | ||
| expect(def.type).toBe(TypeKind.CompoundTypeKind); | ||
| }); | ||
|
|
||
| it('Function inside interface has a label', () => { | ||
| const node = nodes.find((n) => getNodeName(n) === 'ExampleInterface'); | ||
| expect(node).toBeDefined(); | ||
| const def = buildApiDeclaration(node!, plugins, log, plugins[0].manifest.id, ApiScope.CLIENT); | ||
|
|
||
| const fn = def!.children?.find((c) => c.label === 'aFn'); | ||
| expect(fn).toBeDefined(); | ||
| expect(fn?.label).toBe('aFn'); | ||
| expect(fn?.type).toBe(TypeKind.FunctionKind); | ||
| }); |
Oops, something went wrong.