Commit graph

36 commits

Author SHA1 Message Date
Gerard Soldevila
138145411d
SKA: Update repository structure documentation (#208691)
## Summary

* Updates [Repository
structure](https://docs.elastic.dev/kibana-dev-docs/contributing/repo-structure)
docs
* Makes the `osquery` plugin eslint exception more specific.
2025-01-29 13:34:00 -06:00
Gerard Soldevila
fb26c1c683
SKA: Update broken references and URLs (#206836)
## Summary

Updates a number of broken file references and broken links.

---------

Co-authored-by: kibanamachine <42973632+kibanamachine@users.noreply.github.com>
Co-authored-by: Alejandro Fernández Haro <afharo@gmail.com>
2025-01-28 03:32:48 +00:00
Larry Gregory
395e49484e
Add check to fail CI if any dependencies are unowned (#206679)
## Summary
- Updates `scripts/dependency_ownership` to use the
`@kbn/dev-cli-runner` for consistency with other CI-related CLIs.
- Adds a new `failIfUnowned` flag to exit with an error code if any
dependencies are unowned.
- Adds a new dependency ownership check to `quick_checks` and `renovate`
CI steps.


From a CI run, the additional quick check executes successfully in 3
seconds:
```sh
info [quick-checks] Passed check: /opt/buildkite-agent/builds/bk-agent-prod-gcp-abc123/elastic/kibana-pull-request/kibana/.buildkite/scripts/steps/checks/dependencies_missing_owner.sh in 3s
```

---------

Co-authored-by: kibanamachine <42973632+kibanamachine@users.noreply.github.com>
2025-01-16 09:59:04 -05:00
Anton Dosov
3b2ab7b413
Sustainable Kibana Architecture: Move CodeEditor related packages #205587 (#205738)
## Summary

This PR aims at relocating some of the Kibana modules (plugins and
packages) into a new folder structure, according to the _Sustainable
Kibana Architecture_ initiative.

> [!IMPORTANT]
> * We kindly ask you to:
> * Manually fix the errors in the error section below (if there are
any).
> * Search for the `packages[\/\\]` and `plugins[\/\\]` patterns in the
source code (Babel and Eslint config files), and update them
appropriately.
> * Manually review
`.buildkite/scripts/pipelines/pull_request/pipeline.ts` to ensure that
any CI pipeline customizations continue to be correctly applied after
the changed path names
> * Review all of the updated files, specially the `.ts` and `.js` files
listed in the sections below, as some of them contain relative paths
that have been updated.
> * Think of potential impact of the move, including tooling and
configuration files that can be pointing to the relocated modules. E.g.:
>     * customised eslint rules
>     * docs pointing to source code

> [!NOTE]
> * This PR has been auto-generated.
> * Any manual contributions will be lost if the 'relocate' script is
re-run.
> * Try to obtain the missing reviews / approvals before applying manual
fixes, and/or keep your changes in a .patch / git stash.
> * Please use
[#sustainable_kibana_architecture](https://elastic.slack.com/archives/C07TCKTA22E)
Slack channel for feedback.

Are you trying to rebase this PR to solve merge conflicts? Please follow
the steps describe
[here](https://elastic.slack.com/archives/C07TCKTA22E/p1734019532879269?thread_ts=1734019339.935419&cid=C07TCKTA22E).

#### 3 packages(s) are going to be relocated:

| Id | Target folder |
| -- | ------------- |
| `@kbn/code-editor` |
`src/platform/packages/shared/shared-ux/code_editor/impl` |
| `@kbn/code-editor-mock` |
`src/platform/packages/shared/shared-ux/code_editor/mocks` |
| `@kbn/monaco` | `src/platform/packages/shared/kbn-monaco` |


<details >
<summary>Updated relative paths</summary>

```
src/platform/packages/shared/kbn-monaco/jest.config.js:12
src/platform/packages/shared/kbn-monaco/tsconfig.json:2
src/platform/packages/shared/kbn-monaco/tsconfig.type_check.json:2
src/platform/packages/shared/shared-ux/code_editor/impl/jest.config.js:12
src/platform/packages/shared/shared-ux/code_editor/impl/tsconfig.json:16
src/platform/packages/shared/shared-ux/code_editor/impl/tsconfig.json:2
src/platform/packages/shared/shared-ux/code_editor/impl/tsconfig.type_check.json:18
src/platform/packages/shared/shared-ux/code_editor/impl/tsconfig.type_check.json:2
src/platform/packages/shared/shared-ux/code_editor/impl/tsconfig.type_check.json:25
src/platform/packages/shared/shared-ux/code_editor/impl/tsconfig.type_check.json:28
src/platform/packages/shared/shared-ux/code_editor/impl/tsconfig.type_check.json:31
src/platform/packages/shared/shared-ux/code_editor/impl/tsconfig.type_check.json:34
src/platform/packages/shared/shared-ux/code_editor/impl/tsconfig.type_check.json:37
src/platform/packages/shared/shared-ux/code_editor/impl/tsconfig.type_check.json:40
src/platform/packages/shared/shared-ux/code_editor/mocks/tsconfig.json:16
src/platform/packages/shared/shared-ux/code_editor/mocks/tsconfig.json:2
src/platform/packages/shared/shared-ux/code_editor/mocks/tsconfig.type_check.json:18
src/platform/packages/shared/shared-ux/code_editor/mocks/tsconfig.type_check.json:2
src/platform/packages/shared/shared-ux/code_editor/mocks/tsconfig.type_check.json:25
```

</details>
2025-01-08 15:25:47 +01:00
Larry Gregory
8e21442caa
Add dependency docs (#194333)
## Summary

Adds and re-organizes documentation for using third-party dependencies.
2024-10-02 07:55:32 -04:00
Jon
bb55ecd262
[ci] Remove duplicate backport action (#190643)
Depends on https://github.com/elastic/kibana-github-actions/pull/40

This action is no longer needed, we've merged auto-backport into the
current workflow.
2024-08-20 08:23:25 -05:00
Jon
229e7eff0c
[ci] Remove jenkins config (#173745)
We've migrated off and shut down our instance. These files are no longer
needed.
2023-12-21 12:09:43 -06:00
Brandon Kobel
b04b4ea51c
Docs - add logging best practices, and more details about log levels (#170415)
## Summary

Updated developer docs to adding logging best practices and more details
about log levels.

### For maintainers

- [x] This was checked for breaking API changes and was [labeled
appropriately](https://www.elastic.co/guide/en/kibana/master/contributing.html#kibana-release-notes-process)
2023-11-03 07:02:28 -04:00
Yngrid Coello
2e38daf343
Fixing Kibana developer guide (#156970)
While reading [Kibana developer
guide](https://docs-elastic-dev-staging.vercel.app/kibana-dev-docs/contributing/repo-structure#srcdev)
I found
```
Maintained by the Operations team, this code contains build and development tooling related code. This folder existed before `packages`, so contains mostly older code that hasn't been migrated to packages. Prefer creating a `package` if possible. Can be ignored for the most part if you are not on the Ops team. Prefer 
```

Also in [Standards and
guidelines](https://docs-elastic-dev-staging.vercel.app/kibana-dev-docs/standards#backward-compatibility-and-breaking-changes)
the table formatting is off
<img width="879" alt="image"
src="https://user-images.githubusercontent.com/1313018/236801728-06a6f1e9-2d20-4a91-addb-83c918cf45dc.png">
2023-09-12 15:10:21 +02:00
Spencer
52d235ae49
[docs-utils] remove extra api_docs dir (#148658)
In order to avoid searching the `api_docs` directory at the root of the
repo in VSCode we have to exclude all api_docs dirs from search, so
instead of putting the source of the code that generates the api_docs in
a similarly named dir this just removes that wrapper.
2023-01-10 12:20:35 -07:00
Gerard Soldevila
a2036f0ecf
Add new backport labels to dev docs (#137418)
A few functional labels have been recently added to GH, which drive the
behavior of automatic backports:
- `backport:prev-minor`
- `backport:prev-major`
- `backport:all-open`

The [dev
docs](https://docs.elastic.dev/kibana-dev-docs/contributing/github)
contain an overview of the different labels that we find on GH, but
these were missing.

The goal of this PR is to ensure the documentation is up to date.

Co-authored-by: Kibana Machine <42973632+kibanamachine@users.noreply.github.com>
Co-authored-by: Kaarina Tungseth <kaarina.tungseth@elastic.co>
Co-authored-by: Lisa Cawley <lcawley@elastic.co>
2022-12-16 14:45:53 -06:00
Spencer
32491462a9
add kibana.jsonc files to existing packages (#138965)
* [packages] add kibana.jsonc files

* auto-migrate to kibana.jsonc

* support interactive pkg id selection too

* remove old codeowners entry

* skip codeowners generation when .github/CODEOWNERS doesn't exist

* fall back to format validation if user is offline

* update question style

* [CI] Auto-commit changed files from 'node scripts/eslint --no-cache --fix'

Co-authored-by: kibanamachine <42973632+kibanamachine@users.noreply.github.com>
2022-09-08 13:31:57 -07:00
Tyler Smalley
26a503daa7
[docs] Removes another instance of kibCoreSavedObjectsPluginApi (#139735)
Follow-up to #139682

Signed-off-by: Tyler Smalley <tyler.smalley@elastic.co>

Signed-off-by: Tyler Smalley <tyler.smalley@elastic.co>
2022-08-30 07:56:36 -07:00
spalger
2dcc65d803 remove reference to removed plugin in dev-docs 2022-08-22 17:29:40 -07:00
Luke Elmers
209f933ecd
Add section on dependencies to the dev docs. (#139055) 2022-08-18 15:14:55 -06:00
Spencer
6c438b331c
[api-docs] follow the correct schema for frontmatter (#138348)
* [api-docs] follow the correct schema for frontmatter

* rename non-generated summary: usage

* fix yaml comment syntax
2022-08-10 17:17:50 -05:00
Tiago Costa
d5073055fe
docs(NA): breaking up packages into small pieces (#135027)
* docs(NA): update wording around embracing the monorepo

* docs(NA): best practises around breaking up packages

* Update best_practices.mdx

Co-authored-by: Spencer <email@spalger.com>
2022-06-24 03:18:27 +01:00
Raya Fratkina
1eb33f69d6
Corrected triage label and added needs-team (#133524)
* Corrected triage label and added needs-team

* Update dev_docs/contributing/how_we_use_github.mdx

Co-authored-by: Kaarina Tungseth <kaarina.tungseth@elastic.co>

Co-authored-by: Kaarina Tungseth <kaarina.tungseth@elastic.co>
2022-06-06 14:35:25 -04:00
Lisa Cawley
ed8291510b
[DOCS] Add more PR label advice (#133245)
Co-authored-by: Kaarina Tungseth <kaarina.tungseth@elastic.co>
2022-06-02 16:18:19 -07:00
Thomas Watson
2ade11934d
[docs] document yarn.lock backport rules (#132883) 2022-05-25 08:12:58 -07:00
Christiane (Tina) Heiligers
7aa89aac3b
Fix typos in dev docs (#128400) 2022-03-23 11:52:52 -07:00
Garrett Spong
384626bd0b
[dev_docs] Fixes broken REST API template links (#128069)
## Summary

The REST API template links on the main [Documentation page](https://docs.elastic.dev/kibana-dev-docs/contributing/documentation#rest-apis) are broken. They're pointing to the docs `main` branch and the `docs` repo is still on `master` at this moment.

Old Broken Links:
- [API doc template](https://raw.githubusercontent.com/elastic/docs/main/shared/api-ref-ex.asciidoc)
- [API object definition template](https://raw.githubusercontent.com/elastic/docs/main/shared/api-definitions-ex.asciidoc)

New Fixed Links:
- [API doc template](https://raw.githubusercontent.com/elastic/docs/master/shared/api-ref-ex.asciidoc)
- [API object definition template](https://raw.githubusercontent.com/elastic/docs/master/shared/api-definitions-ex.asciidoc)
2022-03-21 09:06:12 -07:00
Stacey Gammon
c4a5a38810
Update best_practices.mdx (#126849)
Co-authored-by: Kibana Machine <42973632+kibanamachine@users.noreply.github.com>
2022-03-10 15:21:03 -07: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
Stacey Gammon
6c4c5e1299
Some updates to our dev docs (#120981)
* Master -> main update branching strategy with make it minor

* Follow the new dev docs process and keep nav inside this repo

* add back nav links that are in a different repo

Co-authored-by: Kibana Machine <42973632+kibanamachine@users.noreply.github.com>
2021-12-13 11:47:03 -05:00
Liza Katz
9e12416d32
Normalize apm transaction names (#119740)
* update task manager apm transactions

* normalize reporting apm transaction names

* update core transaction names

* fix tests

* typo + test

* task manager types

* consts

* reporting transaction type

* dummy

* dummy

* remove unused consts

* Update src/core/server/server.ts

Co-authored-by: Mikhail Shustov <restrry@gmail.com>

* Update src/core/server/server.ts

Co-authored-by: Mikhail Shustov <restrry@gmail.com>

* Update src/core/server/server.ts

Co-authored-by: Mikhail Shustov <restrry@gmail.com>

* new line

* Update x-pack/plugins/task_manager/server/task_running/ephemeral_task_runner.ts

Co-authored-by: ymao1 <ying.mao@elastic.co>

* Update x-pack/plugins/task_manager/server/task_running/ephemeral_task_runner.ts

Co-authored-by: ymao1 <ying.mao@elastic.co>

* alerting code review

* ok

Co-authored-by: Kibana Machine <42973632+kibanamachine@users.noreply.github.com>
Co-authored-by: Mikhail Shustov <restrry@gmail.com>
Co-authored-by: ymao1 <ying.mao@elastic.co>
2021-12-02 19:27:15 +02:00
Spencer
30cdce5d3e
[docs/dev] remove recommendation to use --local (#118561) 2021-11-15 10:38:19 -07:00
Spencer
0e3a2307be
[docs] document using your @elastic.co email to commit (#117428) 2021-11-04 00:15:02 +00: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
Stacey Gammon
0442c87591
High level walkthrough of repo folder structure (#114293)
* Create code_walkthrough.mdx

* Remove unused utilities folder and mention of it in the repo structure doc.

* Update dev_docs/contributing/code_walkthrough.mdx

Co-authored-by: Luke Elmers <lukeelmers@gmail.com>

* Update dev_docs/contributing/code_walkthrough.mdx

Co-authored-by: Luke Elmers <lukeelmers@gmail.com>

* Update dev_docs/contributing/code_walkthrough.mdx

omg my grammar is horrible.

Co-authored-by: Luke Elmers <lukeelmers@gmail.com>

* Update dev_docs/contributing/code_walkthrough.mdx

Co-authored-by: Luke Elmers <lukeelmers@gmail.com>

* Update dev_docs/contributing/code_walkthrough.mdx

Co-authored-by: Luke Elmers <lukeelmers@gmail.com>

* Update dev_docs/contributing/code_walkthrough.mdx

Co-authored-by: Luke Elmers <lukeelmers@gmail.com>

* Update dev_docs/contributing/code_walkthrough.mdx

Co-authored-by: Luke Elmers <lukeelmers@gmail.com>

* review updates

* Update dev_docs/contributing/code_walkthrough.mdx

Co-authored-by: Brandon Kobel <brandon.kobel@gmail.com>

* Update dev_docs/contributing/code_walkthrough.mdx

Co-authored-by: Brandon Kobel <brandon.kobel@gmail.com>

Co-authored-by: Luke Elmers <lukeelmers@gmail.com>
Co-authored-by: Brandon Kobel <brandon.kobel@gmail.com>
2021-10-07 17:42:05 -04:00
garanews
58f6d9002a
Fix typos in docs & dev_docs (#113746) 2021-10-07 14:30:32 -04:00
Kellen
6f665004cb
correct relativity in images (#113834) 2021-10-04 14:19:30 -07:00
Kellen
500fb00271
updates DevPrinciples URL (#113785) 2021-10-04 13:48:22 -04:00
Stacey Gammon
eddbc8db6f
Update doc slugs to improve analytic tracking, move to appropriate folders (#113630)
* Update the slugs to improve google analytics drilldown tracking

* more slug updates

* Fix some formatting issues in building blocks

* update paths

Co-authored-by: Kibana Machine <42973632+kibanamachine@users.noreply.github.com>
2021-10-04 13:36:45 -04:00
Stacey Gammon
ab166240de
Create standards.mdx (#113313)
Co-authored-by: Kibana Machine <42973632+kibanamachine@users.noreply.github.com>
2021-10-01 13:23:37 -04:00
Stacey Gammon
285b1f92ee
Add using GitHub guide to our Developer Guide (#112464)
* Create how_we_use_github.mdx

* Update how_we_use_github.mdx

* note internal only sections
2021-09-17 08:19:56 -04:00