github-mirrors/kibana
1
0
Fork 0
mirror of https://github.com/elastic/kibana.git synced 2025-04-23 17:28:26 -04:00
Code Issues Projects Releases Packages Wiki Activity

correct relativity in images (#113834)

Browse source
This commit is contained in:
Kellen 2021-10-04 14:19:30 -07:00 • committed by GitHub
parent a565fa02f3
commit 6f665004cb
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 3 additions and 3 deletions
Download patch file Download diff file Expand all files Collapse all files

6
dev_docs/contributing/best_practices.mdx
View file

@ -111,7 +111,7 @@ export getSearchService: (searchSpec: { username: string; password: string }) =>
In the former, there will be a link to the `SearchSpec` interface with documentation for the `username` and `password` properties. In the latter the object will render inline, without comments:
![prefer interfaces documentation](./assets/dev_docs_nested_object.png)
![prefer interfaces documentation](../assets/dev_docs_nested_object.png)
#### Export every type used in a public API
@ -135,7 +135,7 @@ export type foo: string | AnInterface;
`Pick` not only ends up being unhelpful in our documentation system, but it's also of limited help in your IDE. For that reason, avoid `Pick` and other similarly complex types on your public API items. Using these semantics internally is fine.
![pick api documentation](./assets/api_doc_pick.png)
![pick api documentation](../assets/api_doc_pick.png)
### Example plugins
@ -210,7 +210,7 @@ your large change right _after_ feature freeze. If you are worried about missing
When possible, build features with incrementals sets of small and focused PRs, but don't check in unused code, and don't expose any feature on master that you would not be comfortable releasing.
![product_stages](./assets/product_stages.png)
![product_stages](../assets/product_stages.png)
If your feature cannot be broken down into smaller components, or multiple engineers will be contributing, you have a few other options to consider.