github-mirrors/kibana
1
0
Fork 0
mirror of https://github.com/elastic/kibana.git synced 2025-06-27 10:40:07 -04:00
Code Issues Projects Releases Packages Wiki Activity

Fixing Kibana developer guide (#156970)

Browse source 
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">
This commit is contained in:
Yngrid Coello 2023-09-12 15:10:21 +02:00 • committed by GitHub
parent 2dd480085e
commit 2e38daf343
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
2 changed files with 7 additions and 6 deletions
Download patch file Download diff file Expand all files Collapse all files

2
dev_docs/contributing/code_walkthrough.mdx
View file

@ -86,7 +86,7 @@ This code primarily belongs to the Core team and contains the plugin infrastruct
### [src/dev](https://github.com/elastic/kibana/tree/main/src/dev)
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
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.
### [src/plugins](https://github.com/elastic/kibana/tree/main/src/plugins)

11
dev_docs/contributing/standards.mdx
View file

@ -91,11 +91,12 @@ Every public API should have a release tag specified at the top of it’s docume
#### Release tags
| Type | Description | Documentation | Asciidoc Tag |
| Undocumented | Every public API should be documented, but if it isn’t, we make no guarantees about it. These need to be eliminated and should become internal or documented. |
| Experimental | A public API that may break or be removed at any time. | experimental[] |
| Beta | A public API that we make a best effort not to break or remove. However, there are no guarantees. | beta[] |
| Stable | No breaking changes outside of a Major\* | stable[] |
| Deprecated | Do not use, will be removed. | deprecated[] |
| -----| ------------| ------------- | ------------ |
| Undocumented | Every public API should be documented, but if it isn’t, we make no guarantees about it. These need to be eliminated and should become internal or documented. | | |
| Experimental | A public API that may break or be removed at any time. | experimental[] | |
| Beta | A public API that we make a best effort not to break or remove. However, there are no guarantees. | beta[] | |
| Stable | No breaking changes outside of a Major\* | stable[] | |
| Deprecated | Do not use, will be removed. | deprecated[] | |
\*This is likely to change with Make it Minor as we move towards a calendar based rolling deprecation and removal policy.