From 2e38daf343b13bbd7c58be8eef2d4b8f012b4f76 Mon Sep 17 00:00:00 2001 From: Yngrid Coello Date: Tue, 12 Sep 2023 15:10:21 +0200 Subject: [PATCH] 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 image --- dev_docs/contributing/code_walkthrough.mdx | 2 +- dev_docs/contributing/standards.mdx | 11 ++++++----- 2 files changed, 7 insertions(+), 6 deletions(-) diff --git a/dev_docs/contributing/code_walkthrough.mdx b/dev_docs/contributing/code_walkthrough.mdx index 617b54e519f1..139ac4df9307 100644 --- a/dev_docs/contributing/code_walkthrough.mdx +++ b/dev_docs/contributing/code_walkthrough.mdx @@ -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) diff --git a/dev_docs/contributing/standards.mdx b/dev_docs/contributing/standards.mdx index aba29e5fab2f..80df5f475213 100644 --- a/dev_docs/contributing/standards.mdx +++ b/dev_docs/contributing/standards.mdx @@ -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.