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