Commit graph

48 commits

Author SHA1 Message Date
James Rodewig
6fdfefe4ff
[DOCS] Update GitHub links in dev docs (#164503) 2023-08-29 14:43:41 -04:00
Alejandro Fernández Haro
e98b4b3e88
[config-schema] offeringBasedSchema helper (#163786)
Co-authored-by: Kibana Machine <42973632+kibanamachine@users.noreply.github.com>
2023-08-22 03:59:15 -07:00
Christiane (Tina) Heiligers
5a68f70900
Update core architecture docs (#164120)
Co-authored-by: Kibana Machine <42973632+kibanamachine@users.noreply.github.com>
Co-authored-by: amyjtechwriter <61687663+amyjtechwriter@users.noreply.github.com>
2023-08-21 15:38:24 -04:00
amyjtechwriter
6666ed4635
[DOCS] Trying to fix broken links, or removing them (#162844)
## Summary

Relates to #162551

Links returning 404 on [Elasticsearch service
page](https://www.elastic.co/guide/en/kibana/current/elasticsearch-service.html)
in the Developer guide.

Replaced the link to the data plug in and one to the global search
plugin (though I'm not sure keeping the sentence and the link to the
global search plugin is useful - maybe we should just remove both
completely). Removed the link 'Elasticsearch service API docs'
altogether.
2023-08-01 18:40:47 +01:00
Brad White
0c3ca366a1
Add build_date to kbn:api/status (#157905)
## Summary

Adds build date to `GET kbn:api/status` similar to ES. Example output
running locally:

```json
{
  "name": "ES-DMVD5M3",
  "uuid": "545ba70c-063e-449b-af21-6c8e7b30f77e",
  "version": {
    "number": "8.9.0",
    "build_hash": "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
    "build_number": 9007199254740991,
    "build_snapshot": false,
    "build_date": "2023-05-15T23:12:09.000Z"
  },
  ...rest
}
```


### Checklist

- [x]
[Documentation](https://www.elastic.co/guide/en/kibana/master/development-documentation.html)
was added for features that require explanation or tutorials
- [x] [Unit or functional
tests](https://www.elastic.co/guide/en/kibana/master/development-tests.html)
were updated or added to match the most common scenarios


## Release Note

The status endpoint now returns the build date alongside other build
information.

---------

Co-authored-by: kibanamachine <42973632+kibanamachine@users.noreply.github.com>
2023-05-25 10:21:47 -07:00
Alejandro Fernández Haro
ff6943376d
[Config Service] Expose serverless contextRef (#156837) 2023-05-08 17:39:12 +02:00
Kaarina Tungseth
1f9eca02a0
[DOCS] Removes legacy plugins (#149545)
## Summary

Removes the outdated legacy plugin docs from the Kibana Developer Guide.

Co-authored-by: Kibana Machine <42973632+kibanamachine@users.noreply.github.com>
2023-01-27 14:47:01 -06:00
Christiane (Tina) Heiligers
f7b25f5e46
[Saved Objects] Provide ability to remove SO type from global SO HTTP API without hiding from the client (#149166)
Co-authored-by: kibanamachine <42973632+kibanamachine@users.noreply.github.com>
resolves https://github.com/elastic/kibana/issues/147150
2023-01-23 15:04:24 -07:00
Michael Dokolin
167797cae1
[Saved Objects] Add documentation covering hidden saved object types (#144647) 2022-11-08 16:42:02 +01:00
Spencer
03f1a218c5
[core] remove root index.ts file (#137001)
* [core] remove root index.ts file

* remove support for `kibana/*` imports, replace instances in docs
2022-07-22 15:04:23 -07:00
Mat Schaffer
8e392a6eed
Add an example of uiSettings override (#135385)
Co-authored-by: Matthias Wilhelm <matthias.wilhelm@elastic.co>
Co-authored-by: Luke Elmers <luke.elmers@elastic.co>
2022-06-30 12:08:55 +09:00
Joe Portner
88d64dc3bb
Add "phase 2" dev docs for sharing saved objects (#128037) 2022-03-22 18:56:41 -04:00
Tobias Stadler
fc6897c17b
Fixed some typos (#125802)
Co-authored-by: Kibana Machine <42973632+kibanamachine@users.noreply.github.com>
Co-authored-by: Kaarina Tungseth <kaarina.tungseth@elastic.co>
2022-03-02 16:40:34 -06:00
gchaps
93cb99db5d
[DOCS] Minor tweaks to upgrade docs (#125538) 2022-02-14 09:31:40 -08:00
gchaps
a13dafc7dd
[DOCS] Updates the Upgrade docs (#125288)
* [DOCS] Adds redirect for Standard Upgrade doc

* [DOCS] Updates Upgrade docs

* [DOCS] Incorporates review comments

* [DOCS] Adds info on saved objects

* [DOCS] Fixes broken link

* [DOCS] Fixes placement of section on unknown saved objects

* [DOCS] Removes duplicate topic
2022-02-10 15:46:58 -08:00
Kaarina Tungseth
f2e9efe457
[DOCS] Adds 8.0.0 release notes (#124399)
* [DOCS] Adds 8.0.0 release notes

* Update docs/CHANGELOG.asciidoc

Co-authored-by: gchaps <33642766+gchaps@users.noreply.github.com>

* Update docs/CHANGELOG.asciidoc

Co-authored-by: Brandon Morelli <bmorelli25@gmail.com>

Co-authored-by: gchaps <33642766+gchaps@users.noreply.github.com>
Co-authored-by: Brandon Morelli <bmorelli25@gmail.com>
2022-02-09 10:15:07 -06:00
Christiane (Tina) Heiligers
483483e788
Adds developer docs for uiSettings (#124648) 2022-02-04 17:30:48 -07:00
Joe Portner
89b1f9056c
Prevent endless loop for saved object migrations (#120146) 2021-12-03 08:42:54 -05:00
Christiane (Tina) Heiligers
9189066b0c
[docs-logging]: move developer/architecture docs to user docs (#119125)
Co-authored-by: Kibana Machine <42973632+kibanamachine@users.noreply.github.com>
2021-11-24 16:42:28 -05:00
Tyler Smalley
c4815d319e
Updates Github link references from master to main (#116789)
Signed-off-by: Tyler Smalley <tyler.smalley@elastic.co>
2021-10-29 09:53:08 -07:00
garanews
58f6d9002a
Fix typos in docs & dev_docs (#113746) 2021-10-07 14:30:32 -04:00
Pierre Gayvallet
a4b74bd398
[8.0] Remove legacy logging (#112305)
* remove kbn-legacy-logging package

* remove legacy service

* remove legacy appender

* remove LegacyObjectToConfigAdapter

* gix types

* remove @hapi/good / @hapi/good-squeeze / @hapi/podium

* remove `default` appender validation for `root` logger

* remove old config key from kibana-docker

* fix FTR config

* fix dev server

* remove reference from readme

* fix unit test

* clean CLI args and remove quiet option

* fix type

* fix status test config

* remove from test config

* fix snapshot

* use another regexp

* update generated doc

* fix createRootWithSettings

* fix some integration tests

* another IT fix

* yet another IT fix

* (will be reverted) add assertion for CI failure

* Revert "(will be reverted) add assertion for CI failure"

This reverts commit 78d5560f9e.

* switch back to json layout for test

* remove legacy logging config deprecations

* address some review comments

* update documentation

* update kibana.yml config examples

* add config example for `metrics.ops`

Co-authored-by: Tyler Smalley <tyler.smalley@elastic.co>
2021-10-05 13:30:56 +02:00
Joe Portner
c21272cc5b
Sharing saved objects developer guide (#107099) 2021-08-10 16:02:45 -04:00
Kaarina Tungseth
524fe6dfe2
[DOCS] Updates to the Reporting docs (#101326)
* [DOCS] Updates to thee Reporting docs

* Adds the main sharing page

* Final changes

* Changed configuring-reporting link to secure-reporting

* Updates from meeting with Tim and Larry

* Moves reporting and sharing content above ML

* Update docs/setup/configuring-reporting.asciidoc

Co-authored-by: Larry Gregory <lgregorydev@gmail.com>

* Review comments from Tim and Larry

* Fixes broken links

* Fixes redirect

* Fixes broken link from ES docs

* Adds metadata to changed pages

* Review comments

Co-authored-by: Larry Gregory <lgregorydev@gmail.com>
2021-06-30 12:10:04 -05:00
Christiane (Tina) Heiligers
d29abdfa15
[DOCS] Adds user-facing docs for the new KP logging configuration (#94993)
Co-authored-by: Lisa Cawley <lcawley@elastic.co>
2021-03-30 07:54:15 -07:00
Lisa Cawley
5d9b84ff75
[DOCS] Clean up text (#90359) 2021-02-05 09:16:28 -08:00
Mikhail Shustov
b3a9754394
[Core] Explicit typings for request handler context (#88718)
* move context to server part. couple with RequestHandlerContext

Context implementation will be simplified in follow-up.

* adopt core code

* adopt bfetch code

* adopt data code

* adopt search examples

* adopt vis_type_timelion

* adopt vis_type_timeseries

* adopt plugin functional tests

* adopt actions

* adopt alerting plugin

* adopt APM plugin

* adopt beats_management

* adopt case plugin

* adopt cross_cluster_replication

* adopt data_enhanced

* adopt event_log

* adopt global_search

* adopt index_management

* adopt infra

* adopt licensing

* adopt lists

* adopt logstash

* adopt reporting

* adopt observability

* adopt monitoring

* adopt rollup

* adopt so tagging

* adopt security

* adopt security_solutions

* adopt watcher

* adopt uptime

* adopt spaces

* adopt snapshot_restore

* adopt features changes

* mute error when null used to extend context

* update docs

* small cleanup

* add type safety for return type

* refactor registerRouteHandlerContext type

* update docs

* update license header

* update docs

* fix type error. fetch body does not accept array of strings

* fix telemetry test

* remove unnecessary ts-ignore

* address comments

* update docs
2021-01-21 15:20:22 +01:00
Mikhail Shustov
ab8a2f7427
[docs] Convert migration guide to asciidoc (#82600)
* Initial conversion to asciidoc

* Update and split migration guide

* Convert MIGRATION_EXAMPLES to asciidoc

* build with --focus flag

* convert migration guide to asciidoc

* cleanup migration_examples

* fix wrong Heading size

* update links in docs

* Apply suggestions from code review

Co-authored-by: Rudolf Meijering <skaapgif@gmail.com>

* Apply suggestions from code review

Co-authored-by: Rudolf Meijering <skaapgif@gmail.com>

* add tooling section

* explain purpose of each lifecycle method

* cleanup docs

* cleanup p2

* fix wrong link

* resturcture core docs

* fix wrong link

* update missing links

* Apply suggestions from code review

Co-authored-by: gchaps <33642766+gchaps@users.noreply.github.com>

* address comments

* add a commenta about plugin-helpers preconfigured

* improve density of tables

* fix lik

* remove links to the migration guide

* address comments

* Apply suggestions from code review

Co-authored-by: gchaps <33642766+gchaps@users.noreply.github.com>

* address @gchaps comments

* Apply suggestions from code review

Co-authored-by: gchaps <33642766+gchaps@users.noreply.github.com>

* change format of ES client change list

Co-authored-by: Josh Dover <me@joshdover.com>
Co-authored-by: Rudolf Meijering <skaapgif@gmail.com>
Co-authored-by: gchaps <33642766+gchaps@users.noreply.github.com>
2020-11-24 09:46:19 +01:00
Larry Gregory
fe33579272
Add support for licensed sub feature privileges (#80905) 2020-11-16 14:50:20 -05:00
Larry Gregory
bf0f8bbb42
Cleanup feature registration (#80909) 2020-10-20 12:53:43 -04:00
Stacey Gammon
df86dcb215
remove file accidentally checked in (#79005) 2020-09-30 15:36:01 -04:00
Rudolf Meijering
8841757874
First stab at developer-focussed saved objects docs (#71430)
* First stab at developer-focussed saved objects docs

* Don't introduce spelling mistakes

* Add docs for SO migrations

* Link to HTTP API documentation

* Grammar fixes

* Rendering fixes

* Migrations should be tested, remove nested migration docs for now

* Drop subtitle field in migration, add notes about migration version, behaviour for corrupt documents and emphasize testing

Co-authored-by: Josh Dover <me@joshdover.com>
2020-09-28 15:53:24 +02:00
Larry Gregory
9f3992f6c2
Grouped features for space management (#74151)
* Grouped features for space management

* Apply suggestions from code review

Co-authored-by: Joe Portner <5295965+jportner@users.noreply.github.com>

* Address PR Feedback

* docs changes

* updating types/docs

* update APM feature name

* Reintroduce extraAction following EUI update

* change ordering of infra features, and render callout for management category

Co-authored-by: Joe Portner <5295965+jportner@users.noreply.github.com>
Co-authored-by: Elastic Machine <elasticmachine@users.noreply.github.com>
2020-09-18 12:30:59 -04:00
Michail Yasonik
61c4e6fd8d
Stacked headers and navigational search (#72331)
Co-authored-by: Poff Poffenberger <poffdeluxe@gmail.com>
Co-authored-by: Ryan Keairns <contactryank@gmail.com>
Co-authored-by: pgayvallet <pierre.gayvallet@elastic.co>
Co-authored-by: cchaos <caroline.horn@elastic.co>
2020-09-14 14:32:30 -05:00
Larry Gregory
2e34eb239f
Hide management sections based on cluster/index privileges (#67791)
Co-authored-by: Elastic Machine <elasticmachine@users.noreply.github.com>
2020-09-14 09:30:47 -04:00
gchaps
d20c653bb4
[DOCS] Adds redirect for rbac content (#75803) 2020-08-24 11:56:14 -07:00
Stacey Gammon
4ffef0a481
Add asciidoc support for generated plugin list (#72292)
* add asciidoc support for generated plugin list

Try level offset "=+2" instead of "=+1" to stop the inlining of the includes.

remove +2 back to +1

* Remove asciidoc, switch to regex. Rearrange dev guide to avoid nesting limit.

* Add tests for regex

* add a description to not throw off the table. Remove the heading from the paragraph snippet.

* Fix more READMEs so table renders correctly

* Update plugin list

* Remove code-exploration file, moved to plugin-list

* fix typo

* Add link to developer examples

* Update plugin list

* fix typo
2020-08-24 11:31:27 -04:00
CJ Cenizal
50499a589c
Surface data stream stats, index template, and ILM policy in the UI (#75107)
* Add Index Management README and quick testing steps for data streams.
* Surface data stream health in Data Streams tab (table and detail panel).
  - Extract out DataHealth component for use in both Data Streams and Indices tabs.
  - Refactor detail panel to use data structure & algo to build component.
  - Refactor detail panel to use i18n.translate instead of FormattedMessage.
* Render index template name and index lifecycle policy name in the detail panel.
* Render storage size and max timestamp information in table and detail panel.
  - Add 'Include stats' switch.
  - Add humanizeTimeStamp service, localized to data streams.
2020-08-21 17:53:03 -07:00
Pierre Gayvallet
890fc31dff
Beats Management plugin: migrate server-side code (#70930)
* move all the legacy codebase to KP plugin

* fix imports

* add empty handler context & rename routes folder

* start migrating routes

* migrate rest of the routes

* migrate adapters

* remove beats from legacy xpack plugin

* use nullable + replace response.custom

* fix wrapRouteWithSecurity, remove incorrect header validation

* remove comment

* updating generated plugin list

* fix typos in doc

* adapt readme too.

* remove old commented routes from route files

* remove eslint disabling

* use camel case for plugin id

* update generated doc

Co-authored-by: Josh Dover <me@joshdover.com>
2020-08-18 12:00:39 +02:00
spalger
ad8502c8d9 update code-exploration docs 2020-08-10 01:25:29 -07:00
Mikhail Shustov
8759646576
update docs (#74364) 2020-08-05 15:28:03 +02:00
Jonathan Buttner
867a672c7a
[Security Solution] Use docker for endpoint tests (#73092)
* Copying api integration tests into their own directory

* Removing api integration tests and using ingest docker image

* Fixing typo

* Fixing type errors and empty string and reenabling tests

* Rebuilding docs

* Renaming url override variable

Co-authored-by: Elastic Machine <elasticmachine@users.noreply.github.com>
2020-07-27 14:13:50 -04:00
Pierre Gayvallet
2178a14519
Migrate status page app to core (#72017)
* move http.anonymousPaths.register('/status'); logic into core, remove status_page plugin

* move status_page to core & migrate lib

* migrate the status_app components to TS/KP APIs

* update rendering snapshots

* use import type syntax

* moves `/status` server-side route to core

* fix route registration

* update generated file

* change statusPage i18n prefix

* (temporary) try to restore legacy plugin to check behavior

* add some FTR tests

* do not import whole lodash

* update snapshots

* review comments

* improve / clean component unit tests

* change url for legacy status app

* set status app as chromeless

* fix FTR test due to chromeless app

* fix typings

* add unit test for CoreApp /status registration
2020-07-23 12:15:03 +02:00
Stacey Gammon
44fc2a828c
Fix indentation level in code exploration doc (#72274)
* fix indentation level in code exploration doc

* run the script to update the file
2020-07-17 12:04:18 -04:00
Stacey Gammon
6a03e8b5b8
Add a few asciidoc readmes (#72082)
* Add a few asciidoc readmes

* add updated code-exploration. Need to fix the script in another go to add asciidoc support. The snippet didn't show up anyway.
2020-07-17 11:08:57 -04:00
Spencer
5a755ddb01
Add plugin list to docs that is generated from the repo (#71731)
Co-authored-by: Stacey Gammon <gammon@elastic.co>
Co-authored-by: spalger <spalger@users.noreply.github.com>
Co-authored-by: Elastic Machine <elasticmachine@users.noreply.github.com>
2020-07-16 12:17:39 -07:00
Stacey Gammon
a20469f038
Clean up the developer guide (#71631)
* rename float to discrete

* use same section title level on all source files

* Elasticsearch => {es}

Co-authored-by: Elastic Machine <elasticmachine@users.noreply.github.com>
2020-07-16 10:13:51 -04:00
Stacey Gammon
0a516cfbb9
Improvements to our developer guide (#67764)
* contributing guide -> asciidoc

* Update docs/developer/contributing/index.asciidoc

Co-authored-by: Peter Schretlen <peter.schretlen@gmail.com>

* Update CONTRIBUTING.md

Co-authored-by: Peter Schretlen <peter.schretlen@gmail.com>

* Update docs/developer/best-practices/stability.asciidoc

Co-authored-by: Peter Schretlen <peter.schretlen@gmail.com>

* Update docs/developer/contributing/index.asciidoc

Co-authored-by: Peter Schretlen <peter.schretlen@gmail.com>

* address code review comments

* Update docs/developer/contributing/development-documentation.asciidoc

Co-authored-by: Peter Schretlen <peter.schretlen@gmail.com>

* review comment updates

* fix bad ref

Co-authored-by: Peter Schretlen <peter.schretlen@gmail.com>
2020-07-13 10:47:01 -04:00