Commit graph

59 commits

Author SHA1 Message Date
Thomas Neirynck
fdc3c0f86b
Add March 2023 Newsletter link (#154248)
Adds link to the March 2023 newsletter.

Blocked by https://github.com/elastic/kibana-team/pull/594. Don't merge
this until that is merged.
2023-04-06 16:04:06 -04:00
Jean-Louis Leysens
62cbac7854
[HTTP] Dev doc for HTTP API versioning (#152739)
## Summary

This contribution adds a new tutorial for how plugin developers must
approach developing and maintaining versionable HTTP APIs.


## How to review
1. Pull down the changes
2. Run `./scripts/dev_docs.sh`
3. Open http://localhost:3000 in your browser
4. Go to "Versioning HTTP APIs" in the side nav
2023-03-07 08:09:49 -05:00
Jean-Louis Leysens
570eb381c5
[Versioned APIs] Versioned interfaces dev docs guide (#150705)
## Summary

Adds a dev docs guide for the core-approved versioning strategy. This
strategy is subject to some iteration but is based on the work we did
for the Saved Objects Management plugin in
https://github.com/elastic/kibana/pull/149495.

Closes https://github.com/elastic/kibana/issues/149929

## How to test

1. Run `./scripts/dev_docs.sh`
2. Navigate to "Versioning interfaces" in the side nav menu

---------

Co-authored-by: Luke Elmers <lukeelmers@gmail.com>
2023-03-01 16:45:43 +01:00
Kibana Machine
6dc52a3c3a
[api-docs] 2023-02-09 Daily api_docs build (#150659)
Generated by
https://buildkite.com/elastic/kibana-api-docs-daily/builds/243
2023-02-09 00:48:16 -05:00
Luke Elmers
4052d18cef
Adds link to Jan 2023 contributors newsletter. (#150259) 2023-02-07 15:53:49 -05:00
Scotty Bollinger
a31d844318
Fix broken page id (#149240)
## Summary

[This
change](https://github.com/elastic/kibana/pull/147533/files#diff-7855e9b3a9d0239ce2c0344047c2f83ee459436b2a2da839d3b5db43e8757451R2)
has
[broken](https://vercel.com/elastic-dev/docs-elastic-dev/ABfUE8aEtaSUUqQ4LRLgcKJ4MuEW)
the internal docs builds because the changed page ID was not updated in
the navigation. This PR fixes that change
2023-01-19 11:28:24 -05:00
Luke Elmers
6a61500505
Adds link to Nov 2022 contributors newsletter. (#147394) 2022-12-13 14:27:34 -05:00
Jean-Louis Leysens
58e6d9441a
[Files] Update the files tutorial after new components (#145356)
## Summary

* Makes the API docs visible on dev site
* Updates the file README
* Updates the file service tutorial (more structured steps, leverage our
own UI components)

Co-authored-by: kibanamachine <42973632+kibanamachine@users.noreply.github.com>
2022-11-16 15:44:03 +01:00
Thomas Neirynck
59f2ff5c2d
Add October newsletter link (#144860)
Adds link to October newsletter
2022-11-09 12:22:33 -05:00
Alejandro Fernández Haro
76e9dd4d1f
[LaunchDarkly] Promote Cloud Experiments documentation in the Dev Docs (#143885) 2022-10-25 11:45:32 +02:00
Thomas Neirynck
fdea7b14b4
Add september newsletter (#142501) 2022-10-05 17:06:16 -04:00
Thomas Neirynck
c2fbe4710f
Add August newsletter (#140129) 2022-09-06 16:08:27 -04:00
Jean-Louis Leysens
e461ad5cc3
more consistent pluralisation (files service -> file service), more consistent casing and added some copy (#140012) 2022-09-05 17:39:15 +02:00
Kibana Machine
cd3931e0be
[api-docs] Daily api_docs build (#139993) 2022-09-05 14:14:59 +09:30
Spencer
e620280d87
[docs/ops] write docs about flaky tests (#139866)
Co-authored-by: Jonathan Budzenski <jon@budzenski.me>
2022-09-01 16:23:49 +01:00
Jean-Louis Leysens
e1e159104e
[Files] Add developer documentation (#139698)
* wip on files docs

* wrote files tutorial v1

* minor tweaks and address PR feedback
2022-09-01 18:13:50 +09:30
spalger
887dea338d remove doc id that no longer resolves 2022-08-31 15:43:11 -05:00
Tyler Smalley
25d8acf105
[docs] Removes kibCoreSavedObjectsPluginApi from nav (#139682)
Signed-off-by: Tyler Smalley <tyler.smalley@elastic.co>

Signed-off-by: Tyler Smalley <tyler.smalley@elastic.co>
2022-08-29 22:11:46 -07:00
Baturalp Gurdin
ec7af1a00b
add docs for how to report performance metrics (#139197)
* add docs for how to report performance metrics

* Update dev_docs/tutorials/adding_performance_metrics.mdx

Co-authored-by: Alejandro Fernández Haro <afharo@gmail.com>

* Update dev_docs/tutorials/adding_performance_metrics.mdx

Co-authored-by: Alejandro Fernández Haro <afharo@gmail.com>

* Update dev_docs/tutorials/adding_performance_metrics.mdx

Co-authored-by: Alejandro Fernández Haro <afharo@gmail.com>

* Update dev_docs/tutorials/adding_performance_metrics.mdx

Co-authored-by: Alejandro Fernández Haro <afharo@gmail.com>

* add dashboard loaded event example

* add note/reminder for free field values

Co-authored-by: Alejandro Fernández Haro <afharo@gmail.com>
Co-authored-by: Kibana Machine <42973632+kibanamachine@users.noreply.github.com>
2022-08-29 17:27:15 +03:00
Michael Dokolin
047d11ea13
[Embeddable] Provide a Redux store adapter for the embeddable input (#136319)
* Add embeddable store factory
* Update embeddable storybook to use store instead of input updates
* Fix embeddable implementation to initialize observables before the constructor
* Add Redux store documentation
* Add missing navigation link to the embeddables documentation
2022-08-18 16:27:22 +02:00
Baturalp Gurdin
ed5d0eaaaf
docs(NA): adds @kbn/test into ops devdocs (#138803) 2022-08-16 11:48:56 +03:00
Spencer
76f1b8d5d4
[IDM] define v2 Kibana manifest schema (#137611)
Co-authored-by: kibanamachine <42973632+kibanamachine@users.noreply.github.com>
2022-08-04 20:19:46 -05:00
Spencer
249b1648b0
[docs] write docs page summarizing the current state of the IDM project (#137915) 2022-08-03 09:19:54 -05:00
Daniel Mitterdorfer
059b74e0d6
Add link to July contributors newsletter (#137082) 2022-07-29 07:52:22 +02:00
Spencer
20f9cf9fd4
[eslint] add rule for validating cross-boundary imports (#137116) 2022-07-25 18:49:17 -05:00
Tiago Costa
302bd423f3
chore(NA): eslint rule for disallowing naked eslint-disable (#136408)
* chore(NA): eslint rule for disallowing naked eslint-disable

* chore(NA): export new rule and update docs

* chore(NA): creation of rule in ts

* chore(NA): new corrected rule in ts

* refact(NA): remove old logic from older plugin

* docs(NA): update documentation

* docs(NA): update documentation

* docs(NA): update documentation

* refact(NA): include edge cases for better locating errors

* chore(NA): changed regex name

* docs(NA): correct name rule on docs

* refact(NA): use dedent in the template literals

* refact(NA): check for undefined

* fix(NA): introduces support for eslint-disable-line

* chore(NA): fix extra space

* test(NA): created more test cases

* chore(NA): rename plugin to eslint-plugin-disable

* docs(NA): update nav and operations landing page ids for eslint rule

* test(NA): use messageIds on test

* chore(NA): complete naked eslint disables with specific rules

* chore(NA): specific rules for a few naked eslint disable

* chore(NA): add focused eslint disable on big reindex_operation_with_large_error_message.ts file

* chore(NA): changes according PR feedback

* chore(NA): include specific eslint rules on latest naked eslint disable

* chore(NA): missing eslint disable specific rule

* fix(NA): remove comment for js annotator

* chore(NA): re add eslint focused disable rule to x-pack/plugins/osquery/cypress/support/coverage.ts

* chore(NA): re add eslint focused disable rule to x-pack/plugins/osquery/cypress/support/coverage.ts

* chore(NA): re add eslint focused disable rule to x-pack/plugins/osquery/cypress/support/coverage.ts

Co-authored-by: Kibana Machine <42973632+kibanamachine@users.noreply.github.com>
2022-07-19 17:11:04 +01:00
Spencer
4f817ad8a0
[kbn/pm] rewrite to avoid needing a build process (#136207)
* [kbn/pm] rewrite to avoid needing a build process

* uncomment timing reporting

* throw in a few missing comments

* Update README.md

* remove extra SomeDevLog interface from ci-stats-core

* remove non-stdio logging from bazel_runner, improve output formatting

* use private fields instead of just ts private props

* promote args to a positional arg

* optionally require the ci-stats-reporter after each command

* allow opt-ing out of vscode config management

* reduce to a single import

* add bit of docs regarding weird imports and package deps of kbn/pm

* clean extraDirs from Kibana's package.json file too

* tweak logging of run-in-packages to use --quiet and not just CI=true

* remove unlazy-loader

* add readme for @kbn/yarn-lock-validator

* convert @kbn/some-dev-logs docs to mdx

* remove missing navigation id and fix id in dev-cli-runner docs

* fix title of some-dev-logs docs page

* typo
2022-07-18 08:46:13 -07:00
Daniel Mitterdorfer
88d0021d17
Add link to June contributors newsletter (#135395) 2022-06-30 07:35:16 +02:00
Tiago Costa
1599cd8d2a
docs(NA): windows wsl development (#134589)
* docs(NA): windows wsl development

* docs(NA): update titles for the documentation created

* chore(NA): update dev_docs/tutorials/development_windows.mdx

Co-authored-by: Jonathan Budzenski <jon@budzenski.me>

* docs(NA): updated guide to include info around GUI apps support

* docs(NA): updated guide to include info around GUI apps support

* docs(NA): include win10 GUI workaround

* docs(NA): run a first sudo command before running others

* docs(NA): added remote code wsl extension

* docs(NA): mentioned NVIDIA does now includes vGPU drivers for WSL within the common drivers

* docs(NA): update sudo commands separation

* docs(NA): added hardware virtualization prerequisite awareness into the guide

* docs(NA): update wording on guide recomendation for win11

Co-authored-by: Jonathan Budzenski <jon@budzenski.me>
Co-authored-by: Kibana Machine <42973632+kibanamachine@users.noreply.github.com>
2022-06-21 00:45:08 +01:00
Larry Gregory
a795237b61
Move audit logging docs to new docs system (#134499)
* Forklift of existing audit logging docs into new docs system

* Add introduction

* Remove old content

* Update dev_docs/key_concepts/audit_logging.mdx
2022-06-16 07:30:05 -04:00
Tiago Costa
25fea16b0f
docs(NA): adds @kbn/plugin-discovery into ops devdocs (#133632)
* docs(NA): adds @kbn/plugin-discovery into ops devdocs

* chore(NA): update packages/kbn-plugin-discovery/README.mdx

Co-authored-by: Jonathan Budzenski <jon@budzenski.me>

Co-authored-by: Jonathan Budzenski <jon@budzenski.me>
2022-06-07 17:16:46 +01:00
Tiago Costa
71652fb45c
docs(NA): adds @kbn/es into ops devdocs (#133353) 2022-06-03 02:44:56 +01:00
Tiago Costa
93204a9297
docs(NA): adds @kbn/cli-dev-mode into ops devdocs (#133012)
Co-authored-by: Kibana Machine <42973632+kibanamachine@users.noreply.github.com>
2022-06-01 23:19:42 +01:00
Stacey Gammon
e74afc41f2
Add link to May contributors newsletter (#133043) 2022-05-26 11:46:03 -05:00
Tiago Costa
0993e83632
docs(NA): adds @kbn/bazel-runner into ops devdocs (#132763) 2022-05-25 20:35:20 -07:00
Tiago Costa
124256701e
docs(NA): adds @kbn/ui-shared-deps-npm into ops devdocs (#132761)
Co-authored-by: Kibana Machine <42973632+kibanamachine@users.noreply.github.com>
2022-05-25 19:28:40 -07:00
Tiago Costa
7cc5982565
docs(NA): adds @kbn/ui-shared-deps-src into ops devdocs (#132760)
* docs(NA): adds @kbn/ui-shared-deps-src into ops devdocs

* chore(NA): document formatting
2022-05-25 03:48:44 +01:00
Katie Hughes
bc284f96fd
Update nav-kibana-dev.docnav.json (#132843) 2022-05-24 15:40:41 -04:00
Tiago Costa
963b91d86b
docs(NA): adds @kbn/babel-plugin-synthentic-packages into ops devdocs (#132512)
* docs(NA): adds @kbn/babel-plugin-synthentic-packages into ops devdocs

* chore(NA): update packages/kbn-babel-plugin-synthetic-packages/README.mdx

Co-authored-by: Jonathan Budzenski <jon@budzenski.me>

Co-authored-by: Jonathan Budzenski <jon@budzenski.me>
2022-05-19 19:28:05 -07:00
Tiago Costa
419d4e2e59
docs(NA): adds @kbn/test-subj-selector into ops devdocs (#132505) 2022-05-20 02:30:01 +01:00
Tiago Costa
d8a62589b3
docs(NA): adding @kbn/ambient-storybook-types into ops docs (#132483) 2022-05-19 00:51:07 +01:00
Tiago Costa
27d96702ff
docs(NA): adding @kbn/ambient-ui-types into ops docs (#132482)
* docs(NA): adding @kbn/ambient-ui-types into ops docs

* docs(NA): wording update
2022-05-18 15:24:19 -07:00
Spencer
a10a4f9f03
Initialize ops documentation section (#132262)
Co-authored-by: Jonathan Budzenski <jon@elastic.co>
Co-authored-by: Tiago Costa <tiago.costa@elastic.co>
2022-05-17 15:22:38 -05:00
Kellen
6f0e4fab80
Update nav-kibana-dev.docnav.json (#131568) 2022-05-04 13:35:14 -07:00
Thomas Neirynck
9740092ace
[DOCS] Add April newsletter to sidenav (#131398) 2022-05-03 11:17:42 -04:00
Greg Back
3ebe072c06
Fix nav-kibana-dev.docnav.json (#130392)
There was a missing comma causing the docs build to fail.
2022-04-15 17:40:33 -04:00
Michael Dokolin
3627b866a3
[Screenshotting] Documentation (#129794)
* Provide defaults for the screenshotting options to make usage closer to the zero-conf
* Add screenshotting example integration
* Add integration tests to cover screenshotting example
* Add screenshotting plugin readme
* Add tutorial to the developer guide
2022-04-15 08:29:05 +02:00
Stacey Gammon
f2266afdda
remove bad link (#129538) 2022-04-05 15:34:01 -07:00
Stacey Gammon
42226652c7
add link to march newsletter (#128777) 2022-03-30 17:19:34 -04:00
Stacey Gammon
e1ac9398d3
Add more details on developer documentation (#126674)
* Docs on docs

* dev docs

* Update dev_docs/contributing/documentation.mdx

Co-authored-by: Daniel Mitterdorfer <danielmitterdorfer@users.noreply.github.com>

* Update dev_docs/contributing/documentation.mdx

Co-authored-by: Daniel Mitterdorfer <danielmitterdorfer@users.noreply.github.com>

* Update dev_docs/contributing/documentation.mdx

Co-authored-by: Daniel Mitterdorfer <danielmitterdorfer@users.noreply.github.com>

* Update dev_docs/contributing/documentation.mdx

Co-authored-by: Daniel Mitterdorfer <danielmitterdorfer@users.noreply.github.com>

* Update dev_docs/contributing/documentation.mdx

Co-authored-by: Daniel Mitterdorfer <danielmitterdorfer@users.noreply.github.com>

* Update dev_docs/contributing/documentation.mdx

Co-authored-by: Daniel Mitterdorfer <danielmitterdorfer@users.noreply.github.com>

* Address review feedback

* Update dev_docs/contributing/documentation.mdx

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

Co-authored-by: Daniel Mitterdorfer <danielmitterdorfer@users.noreply.github.com>
Co-authored-by: Joe Portner <5295965+jportner@users.noreply.github.com>
2022-03-03 11:44:05 -07:00